dataone2.2.2 package

R Interface to the DataONE REST API

getChecksum

Get the checksum for the data object associated with the specified pid...

getCN

Get the coordinating node associated with this D1Client object.

getD1Object

Download a data object from the DataONE Federation.

getData

Get the data content of a D1Object.

AbstractTableDescriber-class

Base Class for Specific Metadata Parsers

addData

Add a D1Object containing a data object to a DataPackage

archive

Archive an object on a Member Node or Coordinating Node, which hides i...

asDataFrame

return the D1Object data as a data.frame.

auth_delete

DELETE a resource with authenticated credentials.

auth_get

GET a resource with authenticated credentials if available.

auth_head

Send a http HEAD request for a resource with authenticated credentials...

auth_post

POST a resource with authenticated credentials.

auth_put

PUT a resource with authenticated credentials.

auth_put_post_delete

POST, PUT, or DELETE a resource with authenticated credentials.

AuthenticationManager-class

Manage DataONE authentication.

AuthenticationManager

Create an AuthenticationManager object

canRead

Test whether the provided subject can read an object.

CertificateManager-class

CertficateManager provides mechanisms to obtain, load, verify, and dis...

CertificateManager

Create a CertificateManager object

CNode-class

Provides R API to DataONE Coordinating Node services.

CNode

Create a CNode object.

convert.csv

Convert a DataFrame to Standard CSV.

createD1Object

Create the Object in the DataONE System

createDataPackage

Create a DataPackage on a DataONE Member Node

createObject

Create an object on a Member Node.

d1_errors

This function parses a DataONE service response message for errors, an...

D1Client-class

The D1Client class contains methods that perform high level DataONE ta...

D1Client-initialize

Initialize a D1Client object

D1Client

The DataONE client class used to download, update and search for data ...

d1IdentifierSearch

Query the DataONE Solr endpoint of the Coordinating Node.

D1Node-class

A base class for CNode and MNode.

D1Node-initialize

Initialize a D1Node

D1Node

Create a D1Node object.

D1Object-class

D1Object (Defunct) is a representation of a DataObject.

D1Object-initialize

Initialize a D1Object

D1Object

Create a D1Object instance.

d1SolrQuery

A method to query the DataONE solr endpoint of the Coordinating Node.

data.characterEncoding

CharacterEncoding

data.formatFamily

Data Format

data.tableAttributeNames

returns the attribute names

data.tableAttributeOrientation

The Attribute (Header) Orientation

data.tableAttributeStorageTypes

returns the attributes' data storage types

data.tableAttributeTypes

returns the attributes' data types

data.tableFieldDelimiter

Field Delimiter

data.tableMissingValueCodes

returns missing value codes

data.tableQuoteCharacter

Quote Character

data.tableSkipLinesHeader

Number of lines to skip before reading data

dataone-defunct

Defunct

dataone-deprecated

Deprecated

dataone

Search, download and upload data to the DataONE network.

describeObject

Efficiently get systemmetadata for an object.

documented.d1Identifiers

Get DataONE identifiers

documented.entityNames

Get the entity names associated with each table

documented.sizes

Get the sizes of the described data tables.

downloadCert

Open the CILogon Certificate download page in the default browser.

downloadObject

Download an object from the DataONE Federation to Disk.

echoCredentials

Echo the credentials used to make the call.

EMLParser-class

Handler for Parsing Table Format Details from Metadata

EMLParser

Construct an EML parser object.

encodeSolr

Encode the input for Solr Queries

encodeUrlPath

Encode the Input for a URL Path Segment.

encodeUrlQuery

Encode the Input for a URL Query Segment.

evaluateAuth

Evaluate DataONE authentication.

generateIdentifier

Get a unique identifier that is generated by the Member Node repositor...

get_user_agent

User agent string

getAuthExpires

Get the expiration date of the current authentication method.

getAuthMethod

Get the current valid authentication mechanism.

getAuthSubject

Get the authentication subject.

getCapabilities

Get the node capabilities description, and store the information in th...

getCert

Get the DataONE X.509 Certificate location.

getCertExpires

Show the date and time when an X.509 certificate expires.

getCertInfo

Get X.509 Certificate information

getCertLocation

Get the file path on disk of the client certificate file.

getDataObject

Download a file (and it's associated system metadata) from the DataONE...

getDataPackage

Download data from the DataONE Federation as a DataPackage.

getEndpoint

Return the URL endpoint for the DataONE Coordinating Node.

getErrorDescription

Extract an error message from an http response.

getFormat

Get information for a single DataONE object format

getFormatId

Get the FormatId of the D1Object

getIdentifier

Get the Identifier of the D1Object

getMetadataMember

Get the DataObject containing package metadata

getMN

Get a member node client based on its node identifier.

getMNode

Get a reference to a node based on its identifier

getMNodeId

Get the member node identifier associated with this D1Client object..

getObject

Get the bytes associated with an object on this Node.

getPackage

Download a data package from a member node.

getQueryEngineDescription

Query a node for the list of query engines available on the node

getSystemMetadata

Get the metadata describing system properties associated with an objec...

getToken

Get the value of the DataONE Authentication Token, if one exists.

getTokenInfo

Get authentication token information

hasReservation

Checks to determine if the supplied subject is the owner of the reserv...

isAuthExpired

Check if the currently valid authentication method has reached the exp...

isAuthorized

Check if an action is authorized for the specified identifier

isAuthValid

Verify authentication for a member node.

isCertExpired

Determine if an X.509 certificate has expired.

listFormats

List all object formats registered in DataONE.

listMemberNodes

List DataONE Member Nodes.

listNodes

Get the list of nodes associated with a CN

listObjects

Retrieve the list of objects that match the search parameters

listQueryEngines

Query a node for the list of query engines available on the node

MNode-class

Provides R API to DataONE Member Node services.

MNode

Create a MNode object representing a DataONE Member Node repository.

obscureAuth

Temporarily disable DataONE authentication.

obscureCert

Obscure the CILogon Client Certificate

parseCapabilities

Construct a Node, using a passed in capabilities XML

parseSolrResult

Parse Solr output into an R list

ping

Test if a node is online and accepting DataONE requests

query

Search DataONE for data and metadata objects

reserveIdentifier

Reserve a identifier that is unique in the DataONE network.

resolve

Get a list of coordinating nodes holding a given pid.

restoreAuth

Restore authentication (after being disabled with obscureAuth).

restoreCert

Restore the CILogon client certificate by renaming it to its original ...

setMNodeId

Set the member node identifier to be associated with the D1Client obje...

setObsoletedBy

Set a pid as being obsoleted by another pid

setPublicAccess

Make the object publicly readable.

showAuth

Display all authentication information

showClientSubject

Get DataONE Identity as Stored in the CILogon Certificate.

updateObject

Update an object on a Member Node, by creating a new object that repla...

updateSystemMetadata

Update the system metadata associated with an object.

uploadDataObject

Upload a DataObject to a DataONE member node.

uploadDataPackage

Upload a DataPackage to a DataONE member node.

Provides read and write access to data and metadata from the DataONE network <https://www.dataone.org> of data repositories. Each DataONE repository implements a consistent repository application programming interface. Users call methods in R to access these remote repository functions, such as methods to query the metadata catalog, get access to metadata for particular data packages, and read the data objects from the data repository. Users can also insert and update data objects on repositories that support these methods.

  • Maintainer: Matthew B. Jones
  • License: Apache License 2.0
  • Last published: 2022-06-10