-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathREADME.Rmd
124 lines (74 loc) · 3.73 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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
---
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%")
```
rwosstarter <img src="man/figures/package-sticker.png" align="right" style="float:right; height:120px;"/>
=========================================================
<!-- badges: start -->
[](https://github.com/frbcesab/rwosstarter/actions/workflows/R-CMD-check.yaml)
[](https://github.com/frbcesab/rwosstarter/actions/workflows/pkgdown.yaml)
[](https://choosealicense.com/licenses/gpl-2.0/)
<!-- badges: end -->
## Table of contents
<p align="left">
• <a href="#overview">Overview</a><br>
• <a href="#requirements">Requirements</a><br>
• <a href="#installation">Installation</a><br>
• <a href="#get-started">Get started</a><br>
• <a href="#citation">Citation</a><br>
• <a href="#contributing">Contributing</a><br>
• <a href="#acknowledgments">Acknowledgments</a>
</p>
## 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.
<https://github.com/FRBCesab/rwosstarter>
## 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.