-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathD1Client-class.Rd
More file actions
42 lines (37 loc) · 2.14 KB
/
D1Client-class.Rd
File metadata and controls
42 lines (37 loc) · 2.14 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/D1Client.R
\docType{class}
\name{D1Client-class}
\alias{D1Client-class}
\title{The D1Client class contains methods that perform high level DataONE tasks}
\description{
The methods in the D1Client class call the low level DataONE API to
perform involved tasks such as uploading all the packages in a DataPackage (i.e
\code{\link[=uploadDataPackage]{uploadDataPackage()}})
}
\section{Slots}{
\describe{
\item{\code{cn}}{The Coordinating Node associated with the D1Client object}
\item{\code{mn}}{The Member Node associated with this D1Client object}
}}
\section{Methods}{
\itemize{
\item \code{\link[=D1Client]{D1Client()}}: Construct a D1Client object
\item \code{\link[=convert.csv]{convert.csv()}}: Convert a DataFrame to Standard CSV
\item \code{\link[=createDataPackage]{createDataPackage()}}: Create a DataPackage on a DataONE Member Node
\item \code{\link[=encodeUrlPath]{encodeUrlPath()}}: Encode the Input for a URL Path Segment
\item \code{\link[=encodeUrlQuery]{encodeUrlQuery()}}: Encode the Input for a URL Query Segment
\item \code{\link[=getDataObject]{getDataObject()}}: Download a single data object from a DataONE Federation member node
\item \code{\link[=getDataPackage]{getDataPackage()}}: Download a collection of data object from the DataONE Federation member node as a DataPackage
\item \code{\link[=getEndpoint]{getEndpoint()}}: Return the URL endpoint for the DataONE Coordinating Node
\item \code{\link[=getMetadataMember]{getMetadataMember()}}: Get the DataObject containing package metadata
\item \code{\link[=getMNodeId]{getMNodeId()}}: Get the member node identifier associated with this D1Client object
\item \code{\link[=listMemberNodes]{listMemberNodes()}}: List DataONE Member Nodes
\item \code{\link[=reserveIdentifier]{reserveIdentifier()}}: Reserve a unique identifier in the DataONE Network
\item \code{\link[=uploadDataObject]{uploadDataObject()}}: Upload a DataObject to a DataONE member node
\item \code{\link[=uploadDataPackage]{uploadDataPackage()}}: Upload a DataPackage to a DataONE member node
}
}
\seealso{
\code{\link[=dataone]{dataone()}} package description.
}