R6 class representing a data structure for a GBIF Description augmented data table (based on the Dawrin core)
Source:R/GBIFDescription.R
GBIFDescription.RdR6 class representing a data structure for a GBIF Description augmented data table (based on the Dawrin core)
R6 class representing a data structure for a GBIF Description augmented data table (based on the Dawrin core)
Details
The GBIFDescription class allows for the specification of data tables that comply with the Description
http://rs.gbif.org/terms/1.0/Descriptionclass specification of GBIF.
Super class
LivingNorwayR::DwCGeneric -> GBIFDescription
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 GBIFDescription object
Usage
GBIFDescription$new(
objectData,
idColumnInfo,
nameAutoMap = FALSE,
defDateFormat = "YYYY-MM-DD",
...
)Arguments
objectDataA
data.framecontaining the data to import into the objectidColumnInfoEither a
characterscalar containing the column name ofobjectDataor anintegerscalar giving the index of the column ofobjectDatathat 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(getGBIFDescriptionMembers()))nameAutoMapA
logicalscalar that ifTRUEmaps the columns ofobjectDatato their respective Darwin core terms based on the column namesdefDateFormatA
characterscalar 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 GBIFDescription class type. Each is either a
characterscalar containing the column name ofobjectDataor anintegerscalar giving the index of the column ofobjectDatathat corresponds to the term. Mappable terms can be found using:sapply(X = getGBIFDescriptionMembers(), FUN = function(curTerm) { curTerm$getTermName() })