reference_taxonomy.Rd 1.11 KB
Newer Older
Eric Coissac's avatar
Eric Coissac committed
1 2 3
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/robitaxid.R, R/taxonomy_methods.R,
%   R/taxonomy_robi.R
Eric Coissac's avatar
Eric Coissac committed
4 5
\name{reference_taxonomy.robitaxid}
\alias{reference_taxonomy.robitaxid}
Eric Coissac's avatar
Eric Coissac committed
6 7 8 9 10
\alias{reference_taxonomy.robilca}
\alias{reference_taxonomy}
\alias{reference_taxonomy.robitaxonomy}
\title{Returns the reference taxonomy of an object}
\usage{
Eric Coissac's avatar
Eric Coissac committed
11 12
\method{reference_taxonomy}{robitaxid}(object)

Eric Coissac's avatar
Eric Coissac committed
13 14
\method{reference_taxonomy}{robilca}(taxonomy)

Eric Coissac's avatar
Eric Coissac committed
15
reference_taxonomy(object)
Eric Coissac's avatar
Eric Coissac committed
16

Eric Coissac's avatar
Eric Coissac committed
17 18 19 20 21 22 23
\method{reference_taxonomy}{robitaxonomy}(object)
}
\arguments{
\item{object}{the interrogated object.}
}
\value{
a robitaxonomy instance.
Eric Coissac's avatar
Eric Coissac committed
24 25 26 27 28
}
\description{
robiobjects including taxonomy can be linked to a reference taxonomy.
This method return this taxonomy.
}
Eric Coissac's avatar
Eric Coissac committed
29 30 31 32 33 34 35 36 37 38 39 40 41 42 43
\details{
For \code{\link[ROBITools2]{robitaxid}}, is no reference taxonomy
         are attached to an instance, then the ROBITools2 default taxonomy
         is returned.
}
\examples{

  x <- robitaxid(c(1,2,2759))
  reference_taxonomy(x)

}
\seealso{
\code{\link[ROBITools2]{get_default_taxonomy}},
         \code{\link[ROBITools2]{set_default_taxonomy}}.
}
Eric Coissac's avatar
Eric Coissac committed
44 45 46
\author{
Eric Coissac
}