-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
93 lines (58 loc) · 2.81 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/",
out.width = "100%"
)
```
rwoslite <img src="man/figures/hexsticker.png" height="120px" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://github.com/FRBCesab/rwoslite/actions/workflows/R-CMD-check.yaml)
[](https://github.com/FRBCesab/rwoslite/actions/workflows/pkgdown.yaml)
[](https://choosealicense.com/licenses/mit/)
[](https://lifecycle.r-lib.org/articles/stages.html#stable)
[](https://www.repostatus.org/#active)
<!-- badges: end -->
This R package is an interface for the [WOS Lite API](https://developer.clarivate.com/apis/woslite).
This package is freely released by the
[FRB-CESAB](https://www.fondationbiodiversite.fr/en/about-the-foundation/le-cesab/)
and allows user to retrieve references from a WOS request.
## Requirements
This package uses the WOS Lite API to access data on scientific literature. You
must first have obtained a Personal API Token by contacting the WOS team.
Then you must store this token as an R Environment variable (i.e. a name-value pairs).
Use the function `usethis::edit_r_environ()` to open the `~/.Renviron` file and add
this line (by replacing z999zzz... with your token):
```
WOS_KEY='z999zzz9zzz999999z9z99zz999zz999'
```
Save the file and relaunch R.
## Installation
You can install the development version from [GitHub](https://github.com/) with:
```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("frbcesab/rwoslite")
```
Then you can attach the package `rwoslite`:
```{r eval = FALSE}
library("rwoslite")
```
## Overview
The general workflow is the following:
- Use the function `rwoslite::wos_search()` to get the total number of references
that match the Web of Science query.
- Use the function `rwoslite::wos_get_records()` to download the references.
## Citation
Please cite this package as:
> Casajus N & Mouquet N (`r format(Sys.Date(), "%Y")`) rwoslite: An R Client for
the WOS Lite API. R package version 0.0.1.
## Code of Conduct
Please note that the `rwoslite` project is released with a
[Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.