This method provides the ability to archive a data or metadata object on the Member Node
provided in the 'mnode' parameter. Archiving removes the object from DataONE search functions,
thereby making it more difficult to find without completely removing the object. Archive is intended
for objects that should not be used by current researchers, but for which there is a desire to maintain
a historical record, such as when journal articles might cite the object. Users can still obtain the
contents of archived objects if they have the identifier, but will not discover it through searches.
archive(x, ...)# S4 method for D1Node
archive(x, pid)
The pid that was archived if successful, otherwise NULL
The MNode or CNode instance on which the object will be created
(Not yet used)
The identifier of the object to be created
Methods that perform write operations (such as createObject and updateObject) on the MN generally
require authentication. For MNs that have implemented the DataONE API version 2.0 and higher, these operations can utilize an
authentication token to provide credentials for write operations in DataONE.
The authentication token is obtained from DataONE (see your account profile on https://search.dataone.org).
See the vignette("v01-dataone-overview") for details.
Also, administrator privilege is required to run archive() on a DataONE Coordinating Node.
D1Node() class description.