describeObject: Efficiently get systemmetadata for an object.

In dataone: R Interface to the DataONE REST API

Efficiently get systemmetadata for an object.

Description

This method provides a lighter weight mechanism than getSystemMetadata() for a client to determine basic properties of the referenced object. This operation requires read privileges for the object specified by 'pid', as is granted with a DataONE authentication token or X.509 certificate.

Usage

describeObject(x, ...)

## S4 method for signature 'D1Node'
describeObject(x, pid)

Arguments

x	The MNode or CNode instance to send request to.
...	(Not yet used)
pid	Identifier for the object in question. May be either a PID or a SID. Transmitted as part of the URL path and must be escaped accordingly.

Value

A list of header elements

See Also

https://purl.dataone.org/architecture/apis/MN_APIs.html#MNRead.describe

Examples

## Not run: 
library(dataone)
mn_uri <- "https://knb.ecoinformatics.org/knb/d1/mn/v1"
mn <- MNode(mn_uri)
pid <- "knb.473.1"
describeObject(mn, pid)
describeObject(mn, "adfadf") # warning message when wrong pid

## End(Not run)

dataone documentation built on June 11, 2022, 1:06 a.m.