From 1ce6bd726f820e15111b2e3ec2cc387d7b55c1f3 Mon Sep 17 00:00:00 2001 From: Will Beasley Date: Sun, 17 Jan 2021 15:18:10 -0600 Subject: [PATCH] updating links ref #57 --- README.Rmd | 2 +- README.md | 27 ++++++++++++++------------- docs/articles/C-retrieval.html | 2 +- docs/index.html | 12 ++++++------ docs/pkgdown.yml | 2 +- vignettes/C-retrieval.Rmd | 2 +- vignettes/C-retrieval.Rmd2 | 2 +- 7 files changed, 25 insertions(+), 24 deletions(-) diff --git a/README.Rmd b/README.Rmd index b4864d4..42a2c63 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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. diff --git a/README.md b/README.md index 724349a..2fb817a 100644 --- a/README.md +++ b/README.md @@ -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, @@ -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") @@ -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(), @@ -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. @@ -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. @@ -220,7 +221,7 @@ get_dataset( ) ``` - ## Dataset (182162): + ## Dataset (182162): ## Version: 1.1, RELEASED ## Release Date: 2020-12-30T00:00:24Z ## License: CC0 @@ -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 . diff --git a/docs/articles/C-retrieval.html b/docs/articles/C-retrieval.html index b5258d7..4cbd6ef 100644 --- a/docs/articles/C-retrieval.html +++ b/docs/articles/C-retrieval.html @@ -102,7 +102,7 @@

2017-06-15

-

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’s book Political Analysis Using R, which is stored at Harvard University’s IQSS Dataverse Network:

+

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, which is stored at Harvard University’s IQSS Dataverse Network:

Monogan, Jamie, 2015, “Political Analysis Using R: Example Code and Data, Plus Data for Practice Problems”, doi:10.7910/DVN/ARKOTI, Harvard Dataverse, V1, UNF:6:+itU9hcUJ8I9E0Kqv8HWHg==

diff --git a/docs/index.html b/docs/index.html index 2559d3b..0a02922 100644 --- a/docs/index.html +++ b/docs/index.html @@ -96,7 +96,7 @@

R Client for Dataverse 4 Repositories

-

Dataverse Project logo

+

Dataverse Project logo

The dataverse package provides access to Dataverse 4 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, 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.

@@ -138,7 +138,7 @@

)

## 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(),
@@ -180,7 +180,7 @@ 

     original    = TRUE,
     server      = "demo.dataverse.org"
   )
-

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.

Note the difference between nls_tsv and nls_original. nls_original preserves the data attributes like value labels, whereas nls_tsv has dropped this or left this in file metadata.

@@ -188,7 +188,7 @@ 

 
## [1] "numeric"

 
 attr(nlsw_original$race, "labels") # original dta has value labels

-
## white black other
+
## white black other 
 ##     1     2     3

 

 

@@ -214,7 +214,7 @@ 

   dataset = "10.70122/FK2/PPIAXE",
   server  = "demo.dataverse.org"
 )
-
## Dataset (182162):
+
## Dataset (182162): 
 ## Version: 1.1, RELEASED
 ## Release Date: 2020-12-30T00:00:24Z
 ## License: CC0
@@ -287,7 +287,7 @@ 

 

 

 Other Installations

-
Users interested in downloading metadata from archives other than Dataverse may be interested in Kurt Hornik’s OAIHarvester and Scott Chamberlain’s oai, which offer metadata download from any web repository that is compliant with the Open Archives Initiative standards. Additionally, rdryad uses OAIHarvester to interface with Dryad. The rfigshare package works in a similar spirit to dataverse with https://figshare.com/.

+
Users interested in downloading metadata from archives other than Dataverse may be interested in Kurt Hornik’s OAIHarvester and Scott Chamberlain’s oai, which offer metadata download from any web repository that is compliant with the Open Archives Initiative standards. Additionally, rdryad uses OAIHarvester to interface with Dryad. The rfigshare package works in a similar spirit to dataverse with https://figshare.com/.
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml index e7f6cff..ebef248 100644 --- a/docs/pkgdown.yml +++ b/docs/pkgdown.yml @@ -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 diff --git a/vignettes/C-retrieval.Rmd b/vignettes/C-retrieval.Rmd index 2b24ded..8afa14c 100644 --- a/vignettes/C-retrieval.Rmd +++ b/vignettes/C-retrieval.Rmd @@ -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== diff --git a/vignettes/C-retrieval.Rmd2 b/vignettes/C-retrieval.Rmd2 index a6c5230..493b2cd 100644 --- a/vignettes/C-retrieval.Rmd2 +++ b/vignettes/C-retrieval.Rmd2 @@ -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==