dvServiceDoc: Get Dataverse Service Document

View source: R/dvServiceDoc.r

dvServiceDocR Documentation

Get Dataverse Service Document

Description

Obtain a Data Deposit API Service Document

Usage

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

Arguments

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 character string of class “dvServiceDoc” containing an XML data structure, which describes the dataverses available to the user and the terms of use for those dataverses.

Author(s)

Thomas J. Leeper

See Also

dvTermsOfUse


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