Skip to content

Commit

Permalink
updating links
Browse files Browse the repository at this point in the history
ref #57
  • Loading branch information
wibeasley committed Jan 17, 2021
1 parent ee57d28 commit 1ce6bd7
Show file tree
Hide file tree
Showing 7 changed files with 25 additions and 24 deletions.
2 changes: 1 addition & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -11,7 +11,7 @@ Sys.setenv("DATAVERSE_SERVER" = "dataverse.harvard.edu")

[![CRAN Version](https://www.r-pkg.org/badges/version/dataverse)](https://cran.r-project.org/package=dataverse) ![Downloads](https://cranlogs.r-pkg.org/badges/dataverse) [![Travis-CI Build Status](https://travis-ci.org/IQSS/dataverse-client-r.png?branch=master)](https://travis-ci.org/IQSS/dataverse-client-r) [![codecov.io](https://codecov.io/github/IQSS/dataverse-client-r/coverage.svg?branch=master)](https://codecov.io/github/IQSS/dataverse-client-r?branch=master)

[![Dataverse Project logo](https://dataverse.org/files/dataverseorg/files/dataverse_project_logo-hp.png "Dataverse Project")](https://dataverse.org)
[![Dataverse Project logo](https://dataverse.org/files/dataverseorg/files/dataverse_project_logo-hp.png)](https://dataverse.org)

The **dataverse** package provides access to [Dataverse 4](https://dataverse.org/) APIs, enabling data search, retrieval, and deposit, thus allowing R users to integrate public data sharing into the reproducible research workflow. **dataverse** is the next-generation iteration of [the **dvn** package](https://cran.r-project.org/package=dvn), which works with Dataverse 3 ("Dataverse Network") applications. **dataverse** includes numerous improvements for data search, retrieval, and deposit, including use of the (currently in development) **sword** package for data deposit and the **UNF** package for data fingerprinting.

Expand Down
27 changes: 14 additions & 13 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,8 +9,7 @@ Status](https://travis-ci.org/IQSS/dataverse-client-r.png?branch=master)](https:
[![codecov.io](https://codecov.io/github/IQSS/dataverse-client-r/coverage.svg?branch=master)](https://codecov.io/github/IQSS/dataverse-client-r?branch=master)

[![Dataverse Project
logo](https://dataverse.org/files/dataverseorg/files/dataverse_project_logo-hp.png
"Dataverse Project")](https://dataverse.org)
logo](https://dataverse.org/files/dataverseorg/files/dataverse_project_logo-hp.png)](https://dataverse.org)

The **dataverse** package provides access to
[Dataverse 4](https://dataverse.org/) APIs, enabling data search,
Expand Down Expand Up @@ -53,12 +52,13 @@ Sys.setenv("DATAVERSE_KEY" = "examplekey12345")

#### Server

Because [there are many Dataverse installations](https://dataverse.org/),
all functions in the R client require specifying what server
installation you are interacting with. This can be set by default with
an environment variable, `DATAVERSE_SERVER`. This should be the
Dataverse server, without the “https” prefix or the “/api” URL path,
etc. For example, the Harvard Dataverse can be used by setting:
Because [there are many Dataverse
installations](https://dataverse.org/), all functions in the R client
require specifying what server installation you are interacting with.
This can be set by default with an environment variable,
`DATAVERSE_SERVER`. This should be the Dataverse server, without the
“https” prefix or the “/api” URL path, etc. For example, the Harvard
Dataverse can be used by setting:

``` r
Sys.setenv("DATAVERSE_SERVER" = "dataverse.harvard.edu")
Expand Down Expand Up @@ -99,7 +99,7 @@ nlsw <-

## Downloading ingested version of data with readr::read_tsv. To download the original version and remove this message, set original = TRUE.

##
##
## ── Column specification ────────────────────────────────────────────────────────────────────────────────────────────────
## cols(
## idcode = col_double(),
Expand Down Expand Up @@ -164,7 +164,8 @@ nlsw_original <-
)
```

Note that even though the file prefix is “.tab”, we use `read_dta`.
Note that even though the file prefix is “.tab”, we use
`haven::read_dta`.

Of course, when the dataset is not ingested (such as a Rds file), users
would always need to specify an `.f` argument for the specific file.
Expand All @@ -183,7 +184,7 @@ class(nlsw_tsv$race) # tab ingested version only has numeric data
attr(nlsw_original$race, "labels") # original dta has value labels
```

## white black other
## white black other
## 1 2 3

#### Reading a dataset as a binary file.
Expand Down Expand Up @@ -220,7 +221,7 @@ get_dataset(
)
```

## Dataset (182162):
## Dataset (182162):
## Version: 1.1, RELEASED
## Release Date: 2020-12-30T00:00:24Z
## License: CC0
Expand Down Expand Up @@ -323,6 +324,6 @@ Scott Chamberlain’s [oai](https://cran.r-project.org/package=oai), which
offer metadata download from any web repository that is compliant with
the [Open Archives Initiative](http://www.openarchives.org/) standards.
Additionally, [rdryad](https://cran.r-project.org/package=rdryad) uses
OAIHarvester to interface with [Dryad](http://datadryad.org/). The
OAIHarvester to interface with [Dryad](https://datadryad.org/stash). The
[rfigshare](https://cran.r-project.org/package=rfigshare) package works
in a similar spirit to **dataverse** with <https://figshare.com/>.
2 changes: 1 addition & 1 deletion docs/articles/C-retrieval.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

12 changes: 6 additions & 6 deletions docs/index.html

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

2 changes: 1 addition & 1 deletion docs/pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ articles:
B-search: B-search.html
C-retrieval: C-retrieval.html
D-archiving: D-archiving.html
last_built: 2021-01-17T17:13Z
last_built: 2021-01-17T21:13Z
urls:
reference: https://IQSS.github.io/dataverse-client-r/reference
article: https://IQSS.github.io/dataverse-client-r/articles
Expand Down
2 changes: 1 addition & 1 deletion vignettes/C-retrieval.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ vignette: >



This vignette shows how to download data from Dataverse using the dataverse package. We'll focus on a Dataverse repository that contains supplemental files for [Jamie Monogan](https://spia.uga.edu/faculty-member/jamie-monogan/)'s book [*Political Analysis Using R*](https://www.springer.com/gb/book/9783319234458), which is stored at Harvard University's [IQSS Dataverse Network](https://dataverse.harvard.edu/):
This vignette shows how to download data from Dataverse using the dataverse package. We'll focus on a Dataverse repository that contains supplemental files for [*Political Analysis Using R*](https://www.springer.com/gb/book/9783319234458), which is stored at Harvard University's [IQSS Dataverse Network](https://dataverse.harvard.edu/):

> Monogan, Jamie, 2015, "Political Analysis Using R: Example Code and Data, Plus Data for Practice Problems", [doi:10.7910/DVN/ARKOTI](https://doi.org/10.7910/DVN/ARKOTI), Harvard Dataverse, V1, UNF:6:+itU9hcUJ8I9E0Kqv8HWHg==
Expand Down
2 changes: 1 addition & 1 deletion vignettes/C-retrieval.Rmd2
Original file line number Diff line number Diff line change
Expand Up @@ -20,7 +20,7 @@ options(width = 120)
knitr::opts_chunk$set(results = "hold")
```

This vignette shows how to download data from Dataverse using the dataverse package. We'll focus on a Dataverse repository that contains supplemental files for [Jamie Monogan](https://spia.uga.edu/faculty-member/jamie-monogan/)'s book [*Political Analysis Using R*](https://www.springer.com/gb/book/9783319234458), which is stored at Harvard University's [IQSS Dataverse Network](https://dataverse.harvard.edu/):
This vignette shows how to download data from Dataverse using the dataverse package. We'll focus on a Dataverse repository that contains supplemental files for [*Political Analysis Using R*](https://www.springer.com/gb/book/9783319234458), which is stored at Harvard University's [IQSS Dataverse Network](https://dataverse.harvard.edu/):

> Monogan, Jamie, 2015, "Political Analysis Using R: Example Code and Data, Plus Data for Practice Problems", [doi:10.7910/DVN/ARKOTI](https://doi.org/10.7910/DVN/ARKOTI), Harvard Dataverse, V1, UNF:6:+itU9hcUJ8I9E0Kqv8HWHg==

Expand Down

0 comments on commit 1ce6bd7

Please sign in to comment.