-
Notifications
You must be signed in to change notification settings - Fork 19
Expand file tree
/
Copy pathgetFormat.Rd
More file actions
37 lines (34 loc) · 877 Bytes
/
getFormat.Rd
File metadata and controls
37 lines (34 loc) · 877 Bytes
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
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/CNode.R
\name{getFormat}
\alias{getFormat}
\alias{getFormat,CNode-method}
\title{Get information for a single DataONE object format}
\usage{
getFormat(x, ...)
\S4method{getFormat}{CNode}(x, formatId)
}
\arguments{
\item{x}{A CNode object instance}
\item{...}{(Not yet used)}
\item{formatId}{The formatId to retrieve.}
}
\value{
A dataframe of all object formats registered in the DataONE Object Format Vocabulary.
}
\description{
Get information for a single DataONE object format
}
\examples{
\dontrun{
library(dataone)
cn <- CNode()
fmt <- getFormat(cn, "eml://ecoinformatics.org/eml-2.1.0")
cat(sprintf("format name: \%s\n", fmt$name))
cat(sprintf("format type: \%s\n", fmt$type))
cat(sprintf("format Id: \%s\n", fmt$id))
}
}
\seealso{
\code{\link[=CNode-class]{CNode()}} class description.
}