serializeSystemMetadata: Serialize a SystemMetadata object to an XML representation

serializeSystemMetadataR Documentation

Serialize a SystemMetadata object to an XML representation

Description

The SystemMetadata object is converted to XML and written to a file.

Usage

serializeSystemMetadata(x, ...)

## S4 method for signature 'SystemMetadata'
serializeSystemMetadata(x, version = "v1", ...)

Arguments

x

The SystemMetadata instance to be serialized.

...

(Not currently used)

version

A character string representing the DataONE API version that this system will be used with (e.g. "v1", "v2").

Details

If the 'version' parameter is specified as *v2* then the SystemMetadata object is serialized according to the DataONE version 2.0 system metadata format.

Value

A character value of the filename that the XML representation of the SystemMetadata object was written to.

the character string representing a SystemMetadata object

See Also

SystemMetadata-class

Examples

library(XML)
doc <- xmlParseDoc(system.file("testfiles/sysmeta.xml", package="datapack"), asText=FALSE)
sysmeta <- new("SystemMetadata")
sysmeta <- parseSystemMetadata(sysmeta, xmlRoot(doc))
sysmetaXML <- serializeSystemMetadata(sysmeta, version="v2")

datapack documentation built on June 11, 2022, 1:05 a.m.