dvDepositQuery: Execute a Data Deposit API Query

Description Usage Arguments Details Value Author(s)

View source: R/dvDepositQuery.r

Description

Primarily an internal function for executing Data Deposit API calls.

Usage

1
2
3
dvDepositQuery( query, fulluri=NULL, dv=getOption('dvn'),
                user=getOption('dvn.user'), pwd=getOption('dvn.pwd'), 
                browser=FALSE, apiversion='v1', httpverb='GET', ...)

Arguments

query

A character string specifying query parameters.

fulluri

Instead of specifying query, dv, and apiversion, one can specify the full URI for a Data Deposit action, perhaps as returned by dvStudyAtom.

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.

apiversion

A character string specifying the Data Deposit API version. Currently only “v1” (the default).

httpverb

A character string specifying one of “GET” (the default), “POST”, “PUT”, or “DELETE”. Not all verbs work on all SWORD URIs.

...

Optionally, additional arguments passed to curlPerform.

Details

Primarily for internal use.

Value

A character string containing an XML data structure.

Author(s)

Thomas J. Leeper


dvn documentation built on May 29, 2017, 5:53 p.m.