diff --git a/DESCRIPTION b/DESCRIPTION index 184a2fb..88c7fb7 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -7,3 +7,4 @@ Author: Eric Coissac Maintainer: Eric Coissac Description: More about what it does (maybe more than one line) License: What license is it under? +RoxygenNote: 6.1.1 diff --git a/NAMESPACE b/NAMESPACE index d75f824..f3e04da 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -1 +1,11 @@ -exportPattern("^[[:alpha:]]+") +# Generated by roxygen2: do not edit by hand + +S3method(exp,q) +S3method(log,q) +export(D.q) +export(D.spectrum) +export(H.q) +export(H.spectrum) +export(mode) +export(tag_bad_pcr) +importFrom(Rdpack,reprompt) diff --git a/biodiversity-metrics.Rproj b/biodiversity-metrics.Rproj index 95e4a2c..493b4c1 100644 --- a/biodiversity-metrics.Rproj +++ b/biodiversity-metrics.Rproj @@ -17,3 +17,4 @@ AutoAppendNewline: Yes BuildType: Package PackageUseDevtools: Yes PackageInstallArgs: --no-multiarch --with-keep.source +PackageRoxygenize: rd,collate,namespace diff --git a/man/exp.q.Rd b/man/exp.q.Rd new file mode 100644 index 0000000..21590c8 --- /dev/null +++ b/man/exp.q.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/generalized_log.R +\name{exp.q} +\alias{exp.q} +\title{Generalized exponential function.} +\usage{ +\method{exp}{q}(x, q = 1, base = exp(1)) +} +\description{ +Generalized exponential function. +} +\references{ +\insertRef{Tsallis:94:00}{ROBITools2} +} +\author{ +Eric Coissac +} diff --git a/man/log.q.Rd b/man/log.q.Rd new file mode 100644 index 0000000..d1fb77e --- /dev/null +++ b/man/log.q.Rd @@ -0,0 +1,17 @@ +% Generated by roxygen2: do not edit by hand +% Please edit documentation in R/generalized_log.R +\name{log.q} +\alias{log.q} +\title{Generalized logaritmic function.} +\usage{ +\method{log}{q}(x, q = 1) +} +\description{ +\deqn{x \longmapsto 1 : \log(x) \approx x-1} +} +\references{ +\insertRef{Tsallis:94:00}{ROBITools2} +} +\author{ +Eric Coissac +}