rwosstarter

:package: An R client to the WOS Starter API

https://github.com/frbcesab/rwosstarter

Repository

:package: An R client to the WOS Starter API

README.Rmd

---
output: github_document
---




```{r, include = FALSE}
knitr::opts_chunk$set(collapse  = TRUE,
                      comment   = "#>",
                      fig.path  = "man/figures/",
                      out.width = "100%")
```



rwosstarter 
=========================================================


[![R CMD Check](https://github.com/frbcesab/rwosstarter/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/frbcesab/rwosstarter/actions/workflows/R-CMD-check.yaml)
[![Website](https://github.com/frbcesab/rwosstarter/actions/workflows/pkgdown.yaml/badge.svg)](https://github.com/frbcesab/rwosstarter/actions/workflows/pkgdown.yaml)
[![License: GPL (>= 2)](https://img.shields.io/badge/License-GPL%20%28%3E%3D%202%29-blue.svg)](https://choosealicense.com/licenses/gpl-2.0/)



## Table of contents


  • Overview

  • Requirements

  • Installation

  • Get started

  • Citation

  • Contributing

  • Acknowledgments



## Overview

The R package `rwosstarter` is a client to the 
[Web of Science Starter API](https://developer.clarivate.com/apis/wos-starter).
It is dedicated to retrieve metadata (including times-cited counts) of 
scientific publications matching search terms. It can be used to run a 
literature synthesis.

`rwosstarter` is freely released by the 
[FRB-CESAB](https://www.fondationbiodiversite.fr/en/about-the-foundation/le-cesab/).




## Requirements

The [Web of Science Starter API](https://developer.clarivate.com/apis/wos-starter) 
uses an API Key access. To obtain your own API key, please visit the 
[Clarivate Developer Portal](https://developer.clarivate.com/) and follow instructions.


Once your access has been granted by Clarivate, you have to store your API key 
on your computer. A good practice in 
[managing secrets](https://cran.r-project.org/web/packages/httr/vignettes/secrets.html) 
is to store this API key as an R Environment variable.

Use the function `usethis::edit_r_environ()` to open the `~/.Renviron` file and add 
this line (replace 'z999zzz...' by your actual API key):

```
WOS_STARTER_KEY='z999zzz9zzz999999z9z99zz999zz999'
```

Save this file and restart R.




## Installation

You can install the development version from [GitHub](https://github.com/) with:

```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("frbcesab/rwosstarter")
```




## Get started

The general workflow is the following:

- Use the function `rwosstarter::wos_search()` to get the total number of references
that match the Web of Science query.
- Use the function `rwosstarter::wos_get_records()` to download reference data.



## Citation

Please cite this package as: 

> Casajus N (`r format(Sys.Date(), "%Y")`) rwosstarter: An R Client to
the Web of Science Starter API. R package version 0.1.




## Contributing

All types of contributions are encouraged and valued. For more information, 
check out our [Contributor Guidelines](https://github.com/FRBCesab/rwosstarter/blob/main/CONTRIBUTING.md).

Please note that the `rwosstarter` project is released with a 
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html). 
By contributing to this project, you agree to abide by its terms.



## Acknowledgments

The author of this project would like to thank Clarivate for giving access to 
the Starter API.

Owner

Citation (CITATION.cff)

# -----------------------------------------------------------
# CITATION file created with {cffr} R package, v0.5.0
# See also: https://docs.ropensci.org/cffr/
# -----------------------------------------------------------
 
cff-version: 1.2.0
message: 'To cite package "rwosstarter" in publications use:'
type: software
license: GPL-2.0-or-later
title: 'rwosstarter: An R Client to the Web of Science Starter API'
version: '0.1'
abstract: A client to the 'Web of Science Starter API' (<https://developer.clarivate.com/apis/wos-starter>)
  dedicated to retrieve metadata (including times-cited counts) of scientific publications
  matching search terms. It can be used to run a literature synthesis. Note that this
  API requires an API Key access (<https://developer.clarivate.com/>).
authors:
- family-names: Casajus
  given-names: Nicolas
  email: nicolas.casajus@fondationbiodiversite.fr
  orcid: https://orcid.org/0000-0002-5537-5294
preferred-citation:
  type: manual
  title: 'rwosstarter: An R client to Web of Science Starter API'
  authors:
  - name: Casajus Nicolas
  year: '2023'
  notes: R package version 0.1
  url: https://github.com/frbcesab/rwosstarter
repository-code: https://github.com/frbcesab/rwosstarter
url: https://github.com/frbcesab/rwosstarter
contact:
- family-names: Casajus
  given-names: Nicolas
  email: nicolas.casajus@fondationbiodiversite.fr
  orcid: https://orcid.org/0000-0002-5537-5294
references:
- type: software
  title: httr
  abstract: 'httr: Tools for Working with URLs and HTTP'
  notes: Imports
  url: https://httr.r-lib.org/
  repository: https://CRAN.R-project.org/package=httr
  authors:
  - family-names: Wickham
    given-names: Hadley
    email: hadley@posit.co
  year: '2023'
- type: software
  title: jsonlite
  abstract: 'jsonlite: A Simple and Robust JSON Parser and Generator for R'
  notes: Imports
  url: https://jeroen.r-universe.dev/jsonlite
  repository: https://CRAN.R-project.org/package=jsonlite
  authors:
  - family-names: Ooms
    given-names: Jeroen
    email: jeroen@berkeley.edu
    orcid: https://orcid.org/0000-0002-4035-0289
  year: '2023'
- type: software
  title: utils
  abstract: 'R: A Language and Environment for Statistical Computing'
  notes: Imports
  authors:
  - name: R Core Team
  location:
    name: Vienna, Austria
  year: '2023'
  institution:
    name: R Foundation for Statistical Computing

GitHub Events

Issues and Pull Requests

Last synced: 6 months ago