R6 DwC archive classSource:
R6 class representing a complete data structure for a Darwin Core archive
DwcArchive class serves a base class to all Darwin Core
archive file types. This class supports all kinds of Darwin Core archive files
but may miss some of the specialised functionality of the more specialist
classes. See https://dwc.tdwg.org/text/the Darwin core archive guide
for more information on the structure of Darwin core archive files.
Create a new
DwCArchive$new(coreDwC, extDwC = NULL, metadata = NULL)
DwCGeneric(or derived class) object that represents the table that corresponds to the 'core' table. Alternatively, this parameter can be
characterscalar giving the location of the Darwin core archive file to initialize the object from
DwCGeneric(or derived class) objects that represent the tables used as extension objects in the Darwin Core archive. If
coreDwCis a character scalar then
extDwCcan also be a character scalar that contains the default file encodings for the files in the Darwin core archive
DwCMetadataobject that contains the metadata for the archive
Export the archive as a Darwin core archive file
DwCArchive$exportAsDwCArchive( fileName, quote = TRUE, sep = "\t", eol = "\n", na = "", dec = ".", qmethod = "escape", fileEncoding = "", emlLocation = "eml.xml" )
characterstring containing the file location of the output Darwin Core Archive.
logicalscalar or a
TRUE, any character or factor columns will be surrounded by double quotes. If a
numericvector, its elements are taken as the indeces of columns to quote. In both cases, row and column names are quoted if they are written. If
FALSE, nothing is quoted.
The field seperator stirng. Values within each row are separated by this string.
The character(s) to print at the end of each line (row).
The string to use for missing values in the data.
The string to use for decimal points in numeric or complex columns: must be a single character
A character string specifying how to deal with embedded double quote characters when quoting strings. Must be one of
"escape", in which case the quote character is escaped in C style by a backslash, or
"double", in which case it is doubled
A character string. If non-empty, declares the encoding to be used on a file so the character data can be re-encoded as they are written
The location to store the EML metadata in the Darwin Core archive
Print the archive information
Retrieve the number of extensions used in the archive
Retrieve the core table in the archive
Retrieve an extension table from the archive
integervector giving the indeces of the extension tables to retrieve from the archive or a
charactervector giving the names of the tables to retrieve from the archive. If this parameter is
NULLthen all extension tables are retrieved
Retrieve the metadata for the archive