datapack1.4.2 package

A Flexible Container to Transport and Manipulate Data and Associated Resources

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 a...

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

DataObject-class

DataObject wraps raw data with system-level metadata

DataObject-initialize

Initialize a DataObject

datapack-deprecated

Deprecated Methods

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

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 wi...

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

ResourceMap-class

ResourceMap provides methods to create, serialize and deserialize an O...

ResourceMap-initialize

Initialize a ResourceMap object

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

SystemMetadata-class

A DataONE SystemMetadata object containing basic identification, owner...

SystemMetadata-initialize

Initialize a DataONE SystemMetadata object with default values or valu...

SystemMetadata

Create DataONE SystemMetadata object

updateMetadata

Update selected elements of the XML content of a DataObject in a DataP...

updateRelationships

Update package relationships by replacing an old identifier with a new...

updateXML

Update selected elements of the XML content of a DataObject

validate

Validate a SystemMetadata object

Provides a flexible container to transport and manipulate complex sets of data. These data may consist of multiple data files and associated meta data and ancillary files. Individual data objects have associated system level meta data, and data files are linked together using the OAI-ORE standard resource map which describes the relationships between the files. The OAI- ORE standard is described at <https://www.openarchives.org/ore/>. Data packages can be serialized and transported as structured files that have been created following the BagIt specification. The BagIt specification is described at <https://datatracker.ietf.org/doc/html/draft-kunze-bagit-08>.

  • Maintainer: Matthew B. Jones
  • License: Apache License (== 2.0)
  • Last published: 2025-10-10