A Flexible Container to Transport and Manipulate Data and Associated Resources


[Up] [Top]

Documentation for package ‘datapack’ version 1.4.1

Help Pages

addAccessRule Add access rules to the specified object.
addAccessRule-method Add access rules to the specified object.
addData Add a DataObject to the DataPackage
addData-method Add a DataObject to the DataPackage
addMember Add a DataObject to the DataPackage
addMember-method Add a DataObject to the DataPackage
calculateChecksum Calculate a checksum for the DataObject using the specified checksum algorithm
calculateChecksum-method Calculate a checksum for the DataObject using the specified checksum algorithm
canRead Test whether the provided subject can read an object.
canRead-method Test whether the provided subject can read an object.
clearAccessPolicy Clear the accessPolicy from the specified object.
clearAccessPolicy-method Clear the accessPolicy from the specified object.
containsId Returns true if the specified object is a member of the package
containsId-method Returns true if the specified object is a member of the package
createFromTriples Populate a ResourceMap with RDF relationships from data.frame.
createFromTriples-method Populate a ResourceMap with RDF relationships from data.frame.
DataObject-class DataObject wraps raw data with system-level metadata
DataObject-initialize Initialize a DataObject
datapack datapack, a container for packages of data and associated metadata
DataPackage-class A class representing a data package
DataPackage-initialize Initialize a DataPackage object.
describeWorkflow Add data derivation information to a DataPackage
describeWorkflow-method Add data derivation information to a DataPackage
dmsg Print a debugging message to stderr.
freeResourceMap Free memory used by a ResouceMap.
freeResourceMap-method Free memory used by a ResouceMap.
getData Get the data content of a specified data object
getData-method Get the data content of a specified data object
getFormatId Get the FormatId of the DataObject
getFormatId-method Get the FormatId of the DataObject
getIdentifier Get the Identifier of the DataObject
getIdentifier-method Get the Identifier of the DataObject
getIdentifiers Get the Identifiers of Package Members
getIdentifiers-method Get the Identifiers of Package Members
getMember Return the Package Member by Identifier
getMember-method Return the Package Member by Identifier
getRelationships Retrieve relationships of package objects
getRelationships-method Retrieve relationships of package objects
getSize Get the Count of Objects in the Package
getSize-method Get the Count of Objects in the Package
getTriples Get the RDF relationships stored in the ResourceMap.
getTriples-method Get the RDF relationships stored in the ResourceMap.
getValue Get values for selected DataPackage members.
getValue-method Get values for selected DataPackage members.
hasAccessRule Determine if an access rules exists
hasAccessRule-method Determine if an access rules exists
initialize-method Initialize a DataObject
initialize-method Initialize a DataPackage object.
initialize-method Initialize a ResourceMap object.
initialize-method Initialize a DataONE SystemMetadata object with default values or values passed in to the constructor.
insertRelationship Record relationships of objects in a DataPackage
insertRelationship-method Record relationships of objects in a DataPackage
parseRDF Parse an RDF/XML resource map from a file.
parseRDF-method Parse an RDF/XML resource map from a file.
parseSystemMetadata Parse an external XML document and populate a SystemMetadata object with the parsed data
parseSystemMetadata-method Parse an external XML document and populate a SystemMetadata object with the parsed data
plotRelationships Plot derivation relationships obtained from getRelationships
plotRelationships-method Plot derivation relationships obtained from getRelationships
recordDerivation Record derivation relationships between objects in a DataPackage
recordDerivation-method Record derivation relationships between objects in a DataPackage
removeAccessRule Remove an access rule from the specified object.
removeAccessRule-method Remove an access rule from the specified object.
removeMember Remove the Specified Member from the Package
removeMember-method Remove the Specified Member from the Package
removeRelationships Remove relationships of objects in a DataPackage
removeRelationships-method Remove relationships of objects in a DataPackage
replaceMember Replace the raw data or file associated with a DataObject
replaceMember-method Replace the raw data or file associated with a DataObject
ResourceMap-class ResourceMap provides methods to create, serialize and deserialize an OAI ORE resource map.
ResourceMap-initialize Initialize a ResourceMap object.
selectMember Return identifiers for objects that match search criteria
selectMember-method Return identifiers for objects that match search criteria
serializePackage Create an OAI-ORE resource map from the package
serializePackage-method Create an OAI-ORE resource map from the package
serializeRDF Serialize a ResouceMap.
serializeRDF-method Serialize a ResouceMap.
serializeSystemMetadata Serialize a SystemMetadata object to an XML representation
serializeSystemMetadata-method Serialize a SystemMetadata object to an XML representation
serializeToBagIt Serialize A DataPackage into a BagIt Archive File
serializeToBagIt-method Serialize A DataPackage into a BagIt Archive File
setPublicAccess Add a Rule to the AccessPolicy to make the object publicly readable.
setPublicAccess-method Add a Rule to the AccessPolicy to make the object publicly readable.
setValue Set values for selected DataPackage members.
setValue-method Set values for selected DataPackage members.
SystemMetadata Create DataONE SystemMetadata object
SystemMetadata-class A DataONE SystemMetadata object containing basic identification, ownership, access policy, replication policy, and related metadata.
SystemMetadata-initialize Initialize a DataONE SystemMetadata object with default values or values passed in to the constructor.
SystemMetadata-method Create DataONE SystemMetadata object
updateMetadata Update selected elements of the XML content of a DataObject in a DataPackage (aka package member).
updateMetadata-method 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.
updateRelationships-method Update package relationships by replacing an old identifier with a new one.
updateXML Update selected elements of the XML content of a DataObject
updateXML-method Update selected elements of the XML content of a DataObject
validate Validate a SystemMetadata object.
validate-method Validate a SystemMetadata object.