File: power.law.fit.Rd

package info (click to toggle)
r-cran-igraph 2.1.4-1
  • links: PTS, VCS
  • area: main
  • in suites: forky, sid, trixie
  • size: 27,044 kB
  • sloc: ansic: 204,981; cpp: 21,711; fortran: 4,090; yacc: 1,229; lex: 519; sh: 52; makefile: 8
file content (52 lines) | stat: -rw-r--r-- 2,132 bytes parent folder | download
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/fit.R
\name{power.law.fit}
\alias{power.law.fit}
\title{Fitting a power-law distribution function to discrete data}
\usage{
power.law.fit(
  x,
  xmin = NULL,
  start = 2,
  force.continuous = FALSE,
  implementation = c("plfit", "R.mle"),
  ...
)
}
\arguments{
\item{x}{The data to fit, a numeric vector. For implementation
\sQuote{\code{R.mle}} the data must be integer values. For the
\sQuote{\code{plfit}} implementation non-integer values might be present and
then a continuous power-law distribution is fitted.}

\item{xmin}{Numeric scalar, or \code{NULL}. The lower bound for fitting the
power-law. If \code{NULL}, the smallest value in \code{x} will be used for
the \sQuote{\code{R.mle}} implementation, and its value will be
automatically determined for the \sQuote{\code{plfit}} implementation. This
argument makes it possible to fit only the tail of the distribution.}

\item{start}{Numeric scalar. The initial value of the exponent for the
minimizing function, for the \sQuote{\code{R.mle}} implementation. Usually
it is safe to leave this untouched.}

\item{force.continuous}{Logical scalar. Whether to force a continuous
distribution for the \sQuote{\code{plfit}} implementation, even if the
sample vector contains integer values only (by chance). If this argument is
false, igraph will assume a continuous distribution if at least one sample
is non-integer and assume a discrete distribution otherwise.}

\item{implementation}{Character scalar. Which implementation to use. See
details below.}

\item{...}{Additional arguments, passed to the maximum likelihood
optimizing function, \code{\link[stats4:mle]{stats4::mle()}}, if the \sQuote{\code{R.mle}}
implementation is chosen. It is ignored by the \sQuote{\code{plfit}}
implementation.}
}
\description{
\ifelse{html}{\href{https://lifecycle.r-lib.org/articles/stages.html#deprecated}{\figure{lifecycle-deprecated.svg}{options: alt='[Deprecated]'}}}{\strong{[Deprecated]}}

\code{power.law.fit()} was renamed to \code{fit_power_law()} to create a more
consistent API.
}
\keyword{internal}