Add man pages for some functions
This commit is contained in:
@@ -7,3 +7,4 @@ Author: Eric Coissac
|
|||||||
Maintainer: Eric Coissac <eric.coissac@metabarcoding.org>
|
Maintainer: Eric Coissac <eric.coissac@metabarcoding.org>
|
||||||
Description: More about what it does (maybe more than one line)
|
Description: More about what it does (maybe more than one line)
|
||||||
License: What license is it under?
|
License: What license is it under?
|
||||||
|
RoxygenNote: 6.1.1
|
||||||
|
|||||||
12
NAMESPACE
12
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)
|
||||||
|
|||||||
@@ -17,3 +17,4 @@ AutoAppendNewline: Yes
|
|||||||
BuildType: Package
|
BuildType: Package
|
||||||
PackageUseDevtools: Yes
|
PackageUseDevtools: Yes
|
||||||
PackageInstallArgs: --no-multiarch --with-keep.source
|
PackageInstallArgs: --no-multiarch --with-keep.source
|
||||||
|
PackageRoxygenize: rd,collate,namespace
|
||||||
|
|||||||
17
man/exp.q.Rd
Normal file
17
man/exp.q.Rd
Normal file
@@ -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
|
||||||
|
}
|
||||||
17
man/log.q.Rd
Normal file
17
man/log.q.Rd
Normal file
@@ -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
|
||||||
|
}
|
||||||
Reference in New Issue
Block a user