URLs | R Documentation |
Get URL of associated file. get_url_*
functions return a URL as
a string. This can be then used in other functions such as curl::curl_download()
.
get_url(
file,
dataset = NULL,
format = c("original", "bundle"),
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
original = TRUE,
...
)
get_url_by_name(
filename,
dataset,
format = c("original", "bundle"),
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
original = TRUE,
...
)
get_url_by_id(
fileid,
dataset = NULL,
format = c("original", "bundle"),
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
original = TRUE,
...
)
get_url_by_doi(
filedoi,
dataset = NULL,
format = c("original", "bundle"),
key = Sys.getenv("DATAVERSE_KEY"),
server = Sys.getenv("DATAVERSE_SERVER"),
original = TRUE,
...
)
file |
An integer specifying a file identifier; or a vector of integers
specifying file identifiers; or, if used with the prefix |
dataset |
A character specifying a persistent identification ID for a dataset,
for example |
format |
A character string specifying a file format for download.
by default, this is “original” (the original file format). If |
key |
A character string specifying a Dataverse server API key. If one
is not specified, functions calling authenticated API endpoints will fail.
Keys can be specified atomically or globally using
|
server |
A character string specifying a Dataverse server.
Multiple Dataverse installations exist, with |
original |
A logical, defaulting to TRUE. If a ingested (.tab) version is
available, download the original version instead of the ingested? If there was
no ingested version, is set to NA. Note in |
... |
Additional arguments passed to an HTTP request function, such as
|
filename |
Filename of the dataset, with file extension as shown in Dataverse (for example, if nlsw88.dta was the original but is displayed as the ingested nlsw88.tab, use the ingested version.) |
fileid |
A numeric ID internally used for |
filedoi |
A DOI for a single file (not the entire dataset), of the form
|
This function does not download the associated data.
In contrast, get_dataframe()
downloads the requested file to a tempfile, and then uses R
to read it. And get_file(.., return_url = FALSE)
reads the binary file into
R's memory with httr::GET()
. get_url()
simply return the URL for download.
A string or a list of strings that are URLs.
## Not run:
# get URLs
get_url_by_name(
filename = "nlsw88.tab",
dataset = "10.70122/FK2/PPIAXE",
server = "demo.dataverse.org"
)
# https://demo.dataverse.org/api/access/datafile/1734017?format=original
# For ingested, tab-delimited files
get_url_by_name(
filename = "nlsw88.tab",
dataset = "10.70122/FK2/PPIAXE",
original = FALSE,
server = "demo.dataverse.org"
)
# https://demo.dataverse.org/api/access/datafile/1734017
# To download to local directory
curl::curl_download(
"https://demo.dataverse.org/api/access/datafile/1734017?format=original",
destfile = "nlsw88.dta")
## End(Not run)
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.