getDataPackage: Download data from the DataONE Federation as a DataPackage.

Description Usage Arguments Details Value See Also Examples

Description

This is convenience method that will download all the members in a DataONE data package and insert them into a DataPackage, including associated SystemMetadata for each package member.

Usage

1
2
3
4
5
getDataPackage(x, identifier, ...)

## S4 method for signature 'D1Client'
getDataPackage(x, identifier, lazyLoad = FALSE,
  limit = "1MB", quiet = TRUE)

Arguments

x

A D1Client object.

identifier

The identifier of a package, package metadata or other package member

...

(not yet used)

lazyLoad

A logical value. If TRUE, then only package member system metadata is downloaded and not data. The default is FALSE.

limit

A character value specifying maximum package member size to download. Specified with "KB", "MB" or "TB" for example: "100KB", "10MB", "20GB", "1TB". The default is "1MB".

quiet

A 'logical'. If TRUE (the default) then informational messages will not be printed.

Details

A 'data package' that resides on a DataONE member node is defined as a collection of digital objects that are described by a metadata document. The

Value

A DataPackage or NULL if the package was not found in DataONE

See Also

D1Client class description.

Examples

1
2
3
4
5
6
7
## Not run: 
library(dataone)
d1c <- D1Client("PROD", "urn:node:KNB")
pid <- "solson.5.1"
pkg <- getDataPackage(d1c, pid)

## End(Not run)

dataone documentation built on July 2, 2018, 1:02 a.m.