API Wrapper for the UK REF 2014 Impact Case Studies Database

Provides wrapper functions around the UK Research Excellence Framework 2014 Impact Case Studies Database API < http://impact.ref.ac.uk/>. The database contains relevant publication and research metadata about each case study as well as several paragraphs of text from the case study submissions. Case studies in the database are licenced under a CC-BY 4.0 licence < http://creativecommons.org/licenses/by/4.0/legalcode>.


Build Status AppVeyor Build Status codecov CRAN_Status_Badge

refimpact provides an API wrapper for the UK Research Excellence Framework 2014 Impact Case Studies Database. You can find more information about this database at http://impact.ref.ac.uk/CaseStudies/.

The data may be of interest to you if you are interested in:

  • text mining
  • directed graphs
  • policies for research funding

Case studies in the database are licenced under a CC-BY 4.0 license. The full license can be found here and a more user-friendly version of the license can be be obtained here.

Please note that this project is released with a Contributor Code of Conduct. By participating in this project you agree to abide by its terms.

Installation

install.packages("refimpact")

Install from Github

install.packages("devtools")
devtools::install_github("perrystephenson/refimpact")

Usage

See the vignette:

vignette("refimpact")

More Information

For more information about a specific function you can use the help commands (for example ?ref_get).

To raise bug reports and issues, please use the issue tracker in Github.

ropensci_footer

News

refimpact 1.0.0

  • Major breaking changes. There is now a single user-facing function ref_get() which takes the API method as an argument. This standardises a lot of the input validation and error handling, as well as reducing the risk of bugs (as there are less lines of code). Functions from previous version of the package are still available, but deprecated.
  • A vignette has been added, and the help documentation has been improved.
  • The package now uses httr when calling the API, which improves reliability and provides much better error messages to the end-user when things go wrong.
  • The phrase parameter to the SearchCaseStudies method now allows text queries of any length and complexity
  • Bundled a ref_tags dataset with the package, to save the end-user from having to iterate through the ListTagValues API method in order to find tags to use as parameters when searching the database
  • Added a contributor code of conduct
  • The entire package was re-written.

refimpact 0.1.0

  • Initial release.

Reference manual

It appears you don't have a PDF plugin for this browser. You can click here to download the reference manual.

install.packages("refimpact")

1.0.0 by Perry Stephenson, 2 years ago


https://github.com/ropensci/refimpact


Report a bug at https://github.com/ropensci/refimpact/issues


Browse source code at https://github.com/cran/refimpact


Authors: Perry Stephenson [aut, cre]


Documentation:   PDF Manual  


Task views: Web Technologies and Services


MIT + file LICENSE license


Imports checkmate, httr, jsonlite, tibble, xml2, curl

Suggests testthat, knitr, roxygen2, rmarkdown


See at CRAN