GBIFReference: R6 class representing a data structure for a GBIF Reference...

In LivingNorway/LivingNorwayR: Creates a Darwin Core Standard compliant data archive ("a data package") for biodiversity data

R6 class representing a data structure for a GBIF Reference augmented data table (based on the Dawrin core)

Description

R6 class representing a data structure for a GBIF Reference augmented data table (based on the Dawrin core)

R6 class representing a data structure for a GBIF Reference augmented data table (based on the Dawrin core)

Details

The GBIFReference class allows for the specification of data tables that comply with the Reference http://rs.gbif.org/terms/1.0/Referenceclass specification of GBIF.

Super class

LivingNorwayR::DwCGeneric -> GBIFReference

Methods

Public methods

• GBIFReference$new()

• GBIFReference$clone()

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 GBIFReference object

Usage

GBIFReference$new(
  objectData,
  idColumnInfo,
  nameAutoMap = FALSE,
  defDateFormat = "YYYY-MM-DD",
  ...
)

Arguments

objectData

A data.frame containing the data to import into the object

idColumnInfo

Either a character scalar containing the column name of objectData or an integer scalar giving the index of the column of objectData 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 running names(getGBIFReferenceMembers()))

nameAutoMap

A logical scalar that if TRUE maps the columns of objectData to their respective Darwin core terms based on the column names

defDateFormat

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 GBIFReference class type. Each is either a character scalar containing the column name of objectData or an integer scalar giving the index of the column of objectData that corresponds to the term. Mappable terms can be found using: sapply(X = getGBIFReferenceMembers(), FUN = function(curTerm) { curTerm$getTermName() })

Returns

A new GBIFReference object

---

Method clone()

The objects of this class are cloneable with this method.

Usage

GBIFReference$clone(deep = FALSE)

Arguments

deep

Whether to make a deep clone.

See Also

DwCTerm getGBIFReferenceMembers

LivingNorway/LivingNorwayR documentation built on Jan. 11, 2024, 5:07 a.m.