dvStudyAtom: Obtain a study's Atom document

In ropensci/dvn: Access to Dataverse 3 APIs

Obtain a study's Atom document

Description

Use Data Deposit API to obtain an Atom document for a study.

Usage

dvStudyAtom(objectid, dv=getOption('dvn'),
            user=getOption('dvn.user'), pwd=getOption('dvn.pwd'),
            browser=FALSE, ...)

Arguments

objectid	Either a character string containing the id for a dataverse study (a handle) or an object of class “dvStudyAtom”. This could be returned from dvUserStudies (or, dvSearch, from the Data Sharing API).
dv	An optional character string specifying the Dataverse to query. Default is the Harvard IQSS Dataverse.
user	A character string containing a dataverse username. Default is options('dvn.user').
pwd	A character string containing the corresponding dataverse password. Default is options('dvn.pwd').
browser	A logical specifying whether the query should be executed in a web browser. Default is FALSE.
...	Optionally, additional arguments passed to getURL via dvDepositQuery.

Value

A list containing:

bibliographicCitation	A full citation for the study, compiled from metadata.
generator	A vector containing details about the SWORD application.
id	The full URI for the study.
objectId	The objectId for the study.
xml	A character string containing an XML data structure that includes a study citation and handle.

Author(s)

Thomas J. Leeper

See Also

dvUserStudies dvStudyStatement

ropensci/dvn documentation built on May 18, 2022, 9:52 a.m.