DwCMetadata | R Documentation |
R6 class that represents metadata in DwC
R6Class
object.
The DwCMetadata
class exists as a handling class for the encapsulation and
handling of metadata being presented
importFromLivingNorwayHTML()
Retrieve metadata information from a HTML file that has been created with a Living Norway HTML tag schema
DwCMetadata$importFromLivingNorwayHTML(fileLocation, fileEncoding = "", ...)
fileLocation
A character
scalar containing the location of the
HTML file
fileEncoding
A character
scalar. If non-empty, declares the encoding to be used on a file so the
character data can be re-encoded as they are written
...
A set of arguments to be passed to the xml_new_root
function to define namespace information. The values returned by the helper function
getDefaultEMLDefinitionInfo
will be used unless
overwritten by user input here. In addition, arguments required by the EML standard but
not provided here (such as the packageID
attribute) will be otherwise auto-generated
importFromLivingNorwayRMD()
Retrieve metadata information from a RMD file that has been created with a Living Norway HTML tag schema
DwCMetadata$importFromLivingNorwayRMD(fileLocation, fileEncoding = "", ...)
fileLocation
A character
scalar containing the location of the
RMD file
fileEncoding
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
...
A set of arguments to be passed to the xml_new_root
function to define namespace information. The values returned by the helper function
getDefaultEMLDefinitionInfo
will be used unless
overwritten by user input here. In addition, arguments required by the EML standard but
not provided here (such as the packageID
attribute) will be otherwise auto-generated
importFromEML()
Retrieve metadata information from an Ecological Metadata Language (EML) file
DwCMetadata$importFromEML(fileLocation, fileEncoding = "")
fileLocation
A character
scalar containing the location of the
RMD file
fileEncoding
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
importFromDwCArchive()
Retrieve metadata information from a Darwin Core archive file
DwCMetadata$importFromDwCArchive(fileLocation, fileEncoding = "")
fileLocation
A character
scalar containing the location of the
RMD file
fileEncoding
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
exportToEML()
Export the metadata as an EML XML file
DwCMetadata$exportToEML(fileLocation, fileEncoding = "")
fileLocation
A character
scalar containing the location to store the EML fiøe
fileEncoding
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
new()
Initialise a metadata object from an import file
DwCMetadata$new(fileLocation, fileEncoding = "", fileType = NA, ...)
fileLocation
A character
scalar containing the location of the import file
fileEncoding
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
fileType
A character
scalar stating the type of the file. File type can be either
"rmarkdown"
, "html"
, "eml"
, or "darwincore"
. If NA
then the
file type will be determined from the file extension
...
A set of arguments to be passed to the xml_new_root
function to define namespace information. The values returned by the helper function
getDefaultEMLDefinitionInfo
will be used unless
overwritten by user input here. In addition, arguments required by the EML standard but
not provided here (such as the packageID
attribute) will be otherwise auto-generated
print()
Print the metadata information to the console
DwCMetadata$print()
getTitle()
Retrieve the title of the dataset
DwCMetadata$getTitle(lang = NA)
lang
A character
scalar that specifies the language of the title to return. This
is useful when the title has multiple translations in the metadata
getCreatorInfo()
Retrieve the information of the dataset creators
DwCMetadata$getCreatorInfo(lang = NA)
lang
A character
scalar that specifies the language of the elements to return. This
is useful when the elements have multiple translations in the metadata
getAbstract()
Retrieve the dataset abstract
DwCMetadata$getAbstract(lang = NA)
lang
A character
scalar that specifies the language of the elements to return. This
is useful when the elements have multiple translations in the metadata
clone()
The objects of this class are cloneable with this method.
DwCMetadata$clone(deep = FALSE)
deep
Whether to make a deep clone.
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.