Skip to content

Commit

Permalink
updaed cran comments, readme, news, and desc file, namespace solrium …
Browse files Browse the repository at this point in the history
…usage
  • Loading branch information
sckott committed Feb 11, 2016
1 parent 27c0e79 commit 035786f
Show file tree
Hide file tree
Showing 7 changed files with 43 additions and 54 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -4,3 +4,4 @@
man-roxygen
README.Rmd
^CONDUCT\.md$
cran-comments\.md$
10 changes: 5 additions & 5 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,20 +1,20 @@
Package: rdatacite
Type: Package
Title: 'DataCite' Client for 'Oai-PMH' Methods and their Search 'API'
Title: 'DataCite' Client for 'OAI-PMH' Methods and their Search 'API'
Description: Client for the web service methods provided
by 'DataCite' (http://datacite.org/), including functions to interface with
by 'DataCite' (<https://www.datacite.org/>), including functions to interface with
their 'OAI-PMH' 'metadata' service, and a 'RESTful' search 'API'. The 'API'
is backed by 'SOLR', allowing expressive queries, including faceting,
statistics on variables, and 'more-like-this' queries.
Version: 0.0.9.9800
Version: 0.1.0
License: MIT + file LICENSE
Authors@R: c(person("Scott", "Chamberlain", role = c("aut", "cre"),
email = "[email protected]"))
URL: https://github.com/ropensci/rdatacite
BugReports: https://github.com/ropensci/rdatacite/issues
Imports:
oai,
solrium (>= 0.2.4)
oai (>= 0.2.0),
solrium (>= 0.3.0)
Suggests:
knitr,
testthat
Expand Down
6 changes: 6 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,6 @@
rdatacite 0.1.0
===============

NEW FEATURES

* Released to CRAN.
10 changes: 5 additions & 5 deletions R/dc_search.R
Original file line number Diff line number Diff line change
Expand Up @@ -48,30 +48,30 @@
#' }
dc_search <- function(..., verbose = TRUE, errors = "simple", proxy = NULL, callopts=list()) {
check_conn(verbose, errors, proxy)
solr_search(..., callopts = callopts)
solrium::solr_search(..., callopts = callopts)
}

#' @export
#' @rdname dc_search
dc_facet <- function(..., verbose = TRUE, errors = "simple", proxy = NULL, callopts=list()) {
check_conn(verbose, errors, proxy)
solr_facet(..., callopts = callopts)
solrium::solr_facet(..., callopts = callopts)
}

#' @export
#' @rdname dc_search
dc_stats <- function(..., verbose = TRUE, errors = "simple", proxy = NULL, callopts=list()) {
check_conn(verbose, errors, proxy)
solr_stats(..., callopts = callopts)
solrium::solr_stats(..., callopts = callopts)
}

#' @export
#' @rdname dc_search
dc_mlt <- function(..., verbose = TRUE, errors = "simple", proxy = NULL, callopts=list()) {
check_conn(verbose, errors, proxy)
solr_mlt(..., callopts = callopts)
solrium::solr_mlt(..., callopts = callopts)
}

check_conn <- function(verbose, errors, proxy) {
solr_connect(dc_base(), proxy = proxy, errors = errors, verbose = verbose)
solrium::solr_connect(dc_base(), proxy = proxy, errors = errors, verbose = verbose)
}
18 changes: 2 additions & 16 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -21,27 +21,13 @@ knitr::opts_chunk$set(

## Installation

Need `oai` `> v0.2` from CRAN

```{r eval=FALSE}
install.packages("oai")
```

And install a newer version of `solrium` (`>= v0.2.4`), not yet on CRAN.

```{r eval=FALSE}
devtools::install_github("ropensci/solrium")
```

Now install `rdatacite`

from CRAN
Stable CRAN version

```{r eval=FALSE}
install.packages("rdatacite")
```

development version from github
Development version from github

```{r eval=FALSE}
devtools::install_github("ropensci/rdatacite")
Expand Down
40 changes: 12 additions & 28 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -14,30 +14,14 @@ rdatacite

## Installation

Need `oai` `> v0.2` from CRAN


```r
install.packages("oai")
```

And install a newer version of `solrium` (`>= v0.2.4`), not yet on CRAN.


```r
devtools::install_github("ropensci/solrium")
```

Now install `rdatacite`

from CRAN
Stable CRAN version


```r
install.packages("rdatacite")
```

development version from github
Development version from github


```r
Expand Down Expand Up @@ -132,13 +116,13 @@ Search for the term _laser_
dc_search(q = "laser", fl = c('doi','publicationYear'), rows = 5)
#> Source: local data frame [5 x 2]
#>
#> doi publicationYear
#> (chr) (chr)
#> 1 10.5169/SEALS-52668 1982
#> 2 10.2314/GBV:499941845 2004
#> 3 10.2314/GBV:676509665 2011
#> 4 10.2314/GBV:667365621 2010
#> 5 10.2314/GBV:377452467 2002
#> doi publicationYear
#> (chr) (chr)
#> 1 10.17035/D.2016.0008119129 2016
#> 2 10.5169/SEALS-52668 1982
#> 3 10.2314/GBV:676509665 2011
#> 4 10.2314/GBV:667365621 2010
#> 5 10.2314/GBV:574957529 2007
```

Another search: published between 2000 and 2005
Expand Down Expand Up @@ -168,9 +152,9 @@ dc_facet(q = "wind", facet.field = 'publisher_facet', facet.limit = 5)
#> $facet_fields
#> $facet_fields$publisher_facet
#> X1 X2
#> 1 PANGAEA - Data Publisher for Earth & Environmental Science 30661
#> 1 PANGAEA - Data Publisher for Earth & Environmental Science 30670
#> 2 Data-Planet™ Statistical Ready Reference by Conquest Systems, Inc. 1119
#> 3 Unpublished 759
#> 3 Unpublished 760
#> 4 Figshare 317
#> 5 Archaeology Data Service 263
#>
Expand All @@ -193,7 +177,7 @@ dc_facet(q = "wind", facet.field = 'publisher_facet', facet.limit = 5)
dc_stats(q = "ecology", stats.field = 'date')
#> $data
#> min max count missing
#> date 01-Jan-2007/29-Nov-2010 September 30, 2015 13321 3967
#> date 01-Jan-2007/29-Nov-2010 September 30, 2015 13584 3989
#>
#> $facet
#> NULL
Expand Down
12 changes: 12 additions & 0 deletions cran-comments.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,12 @@
I have read and agree to the the CRAN policies at
http://cran.r-project.org/web/packages/policies.html

R CMD CHECK passed on my local OS X install with R 3.2.3 and
R development version, Ubuntu running on Travis-CI, and WinBuilder.

This is a new package.

R CHECK will likely suggest spelling changes for 'OAI-PMH' to 'Oai-PMH', but
'OAI-PMH' is the correct form.

Thanks! Scott Chamberlain

0 comments on commit 035786f

Please sign in to comment.