Commit c8ada2cb by Eric Coissac

Add man pages for some functions

parent 7d3def0d
......@@ -7,3 +7,4 @@ Author: Eric Coissac
Maintainer: Eric Coissac <eric.coissac@metabarcoding.org>
Description: More about what it does (maybe more than one line)
License: What license is it under?
RoxygenNote: 6.1.1
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
PackageUseDevtools: Yes
PackageInstallArgs: --no-multiarch --with-keep.source
PackageRoxygenize: rd,collate,namespace
% 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
}
% 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
}
Markdown is supported
0% or
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment