poweRlaw: get_ntail – R documentation

Become an expert in R — Interactive courses, Cheat Sheets, certificates and more!

get_ntail

Values greater than or equal to xmin

Description

Returns the number of data points greater than or equal to current value of xmin. In the Clauset et al, paper this is called 'ntail'.

Usage

get_ntail(m, prop = FALSE, lower = FALSE)

Arguments

`m`	a distribution object.
`prop`	default `FALSE`. Return the value as a proportion of the total sample size
`lower`	default `FALSE`. If `TRUE` returns sample size - ntail

Examples

################################################
# Load data and create example object
################################################
data(moby_sample)
m = displ$new(moby_sample)
m$setXmin(7)
################################################
# Get ntail
################################################
get_ntail(m)
sum(moby_sample >= 7)

poweRlaw

Analysis of Heavy Tailed Distributions

v0.70.6

GPL-2 | GPL-3

Authors

Colin Gillespie [aut, cre] (<https://orcid.org/0000-0003-1787-0275>)

Initial release