Function reference • datapack

All functions

DataObject-class: DataObject wraps raw data with system-level metadata

initialize(<DataObject>): Initialize a DataObject

DataPackage-class: A class representing a data package

initialize(<DataPackage>): Initialize a DataPackage object.

ResourceMap-class: ResourceMap provides methods to create, serialize and deserialize an OAI ORE resource map.

initialize(<ResourceMap>): Initialize a ResourceMap object.

SystemMetadata-class: A DataONE SystemMetadata object containing basic identification, ownership, access policy, replication policy, and related metadata.

initialize(<SystemMetadata>): Initialize a DataONE SystemMetadata object with default values or values passed in to the constructor.

SystemMetadata(): Create DataONE SystemMetadata object

addAccessRule(): Add access rules to the specified object.

addData(): Add a DataObject to the DataPackage

addMember(): Add a DataObject to the DataPackage

calculateChecksum(): Calculate a checksum for the DataObject using the specified checksum algorithm

canRead(): Test whether the provided subject can read an object.

clearAccessPolicy(): Clear the accessPolicy from the specified object.

containsId(): Returns true if the specified object is a member of the package

createFromTriples(): Populate a ResourceMap with RDF relationships from data.frame.

datapack: datapack, a container for packages of data and associated metadata

describeWorkflow(): Add data derivation information to a DataPackage

dmsg(): Print a debugging message to stderr.

freeResourceMap(): Free memory used by a ResouceMap.

getData(): Get the data content of a specified data object

getFormatId(): Get the FormatId of the DataObject

getIdentifier(): Get the Identifier of the DataObject

getIdentifiers(): Get the Identifiers of Package Members

getMember(): Return the Package Member by Identifier

getRelationships(): Retrieve relationships of package objects

getSize(): Get the Count of Objects in the Package

getTriples(): Get the RDF relationships stored in the ResourceMap.

getValue(): Get values for selected DataPackage members.

hasAccessRule(): Determine if an access rules exists

insertRelationship(): Record relationships of objects in a DataPackage

parseRDF(): Parse an RDF/XML resource map from a file.

parseSystemMetadata(): Parse an external XML document and populate a SystemMetadata object with the parsed data

plotRelationships(): Plot derivation relationships obtained from getRelationships

recordDerivation(): Record derivation relationships between objects in a DataPackage

removeAccessRule(): Remove an access rule from the specified object.

removeMember(): Remove the Specified Member from the Package

removeRelationships(): Remove relationships of objects in a DataPackage

replaceMember(): Replace the raw data or file associated with a DataObject

selectMember(): Return identifiers for objects that match search criteria

serializePackage(): Create an OAI-ORE resource map from the package

serializeRDF(): Serialize a ResouceMap.

serializeSystemMetadata(): Serialize a SystemMetadata object to an XML representation

serializeToBagIt(): Serialize A DataPackage into a BagIt Archive File

setPublicAccess(): Add a Rule to the AccessPolicy to make the object publicly readable.

setValue(): Set values for selected DataPackage members.

updateMetadata(): Update selected elements of the XML content of a DataObject in a DataPackage (aka package member).

updateRelationships(): Update package relationships by replacing an old identifier with a new one.

updateXML(): Update selected elements of the XML content of a DataObject

validate(): Validate a SystemMetadata object.