R6 class representing a data structure for a GBIF Taxon augmented data table (based on the Dawrin core)
Source:R/GBIFTaxon.R
GBIFTaxon.Rd
R6 class representing a data structure for a GBIF Taxon augmented data table (based on the Dawrin core)
R6 class representing a data structure for a GBIF Taxon augmented data table (based on the Dawrin core)
Details
The GBIFTaxon
class allows for the specification of data tables that comply with the Taxon
http://rs.tdwg.org/dwc/terms/Taxonclass specification of GBIF.
Super class
LivingNorwayR::DwCGeneric
-> GBIFTaxon
Methods
Inherited methods
LivingNorwayR::DwCGeneric$exportAsDataFrame()
LivingNorwayR::DwCGeneric$exportTable()
LivingNorwayR::DwCGeneric$getAssociatedTerms()
LivingNorwayR::DwCGeneric$getDefaultYearFormat()
LivingNorwayR::DwCGeneric$getDwCClassName()
LivingNorwayR::DwCGeneric$getDwCTermInfo()
LivingNorwayR::DwCGeneric$getIDIndex()
LivingNorwayR::DwCGeneric$getIDName()
LivingNorwayR::DwCGeneric$getTableName()
LivingNorwayR::DwCGeneric$getTableTermName()
LivingNorwayR::DwCGeneric$getTermMapping()
LivingNorwayR::DwCGeneric$importDataTable()
LivingNorwayR::DwCGeneric$print()
LivingNorwayR::DwCGeneric$setDefaultYearFormat()
LivingNorwayR::DwCGeneric$setTableName()
Method new()
Create a new GBIFTaxon object
Usage
GBIFTaxon$new(
objectData,
idColumnInfo,
nameAutoMap = FALSE,
defDateFormat = "YYYY-MM-DD",
...
)
Arguments
objectData
A
data.frame
containing the data to import into the objectidColumnInfo
Either a
character
scalar containing the column name ofobjectData
or aninteger
scalar giving the index of the column ofobjectData
that corresponds to the ID variable. Alternatively, this parameter may be the qualified name of the Darwin core term for which the appropriately mapped column will be used as the ID variable (the possible Darwin core term names can be found by runningnames(getGBIFTaxonMembers())
)nameAutoMap
A
logical
scalar that ifTRUE
maps the columns ofobjectData
to their respective Darwin core terms based on the column namesdefDateFormat
A
character
scalar providing the default format for strings denoting dates in the data table. See the https://dwc.tdwg.org/text/#1-introductionDarwin Core text guide for expected values for this string....
A named set of paramaeters corresponding to Darwin core terms associated with the GBIFTaxon class type. Each is either a
character
scalar containing the column name ofobjectData
or aninteger
scalar giving the index of the column ofobjectData
that corresponds to the term. Mappable terms can be found using:sapply(X = getGBIFTaxonMembers(), FUN = function(curTerm) { curTerm$getTermName() })