https://github.com/dataoneorg/scythe
Scythe, the data citation harvester
https://github.com/dataoneorg/scythe
Last synced: 11 months ago
JSON representation
Scythe, the data citation harvester
- Host: GitHub
- URL: https://github.com/dataoneorg/scythe
- Owner: DataONEorg
- License: other
- Created: 2020-04-01T23:52:49.000Z (about 6 years ago)
- Default Branch: main
- Last Pushed: 2024-09-18T23:47:29.000Z (almost 2 years ago)
- Last Synced: 2024-09-19T01:31:34.222Z (almost 2 years ago)
- Language: R
- Size: 2.78 MB
- Stars: 7
- Watchers: 14
- Forks: 2
- Open Issues: 18
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- License: LICENSE.md
Awesome Lists containing this project
README
[](https://github.com/DataONEorg/scythe/actions)
[](https://codecov.io/gh/DataONEorg/scythe?branch=develop)
[](https://www.repostatus.org/#wip)
- **Authors**: Jeanette Clark, Matthew B. Jones, Maya Samet, Althea Marks
- [doi:10.18739/A2VT1GR7M](http://doi.org/10.18739/A2VT1GR7M)
- **License**: [Apache 2](http://opensource.org/licenses/Apache-2.0)
- [Package source code on Github](https://github.com/DataONEorg/scythe)
- [**Submit Bugs and feature requests**](https://github.com/DataONEorg/scythe/issues)
Automates the full text harvesting of dataset citations from various full text article databases,
including Scopus, PLOS, Springer, and XDD.
## Installation
### Released version
```
remotes::install_github("DataONEorg/scythe@v1.1.0")
```
The *scythe* R package should be available for use at this point.
### Development version
Development versions can be installed from GitHub.
```
remotes::install_github("DataONEorg/scythe@develop")
```
## Quick Start
To set API keys for use in the package, see the section below on authentication.
```
library(scythe)
scythe_set_key(source = "scopus", secret = "YOUR KEY")
identifier <- "10.18739/A22274"
results <- citation_search(identifier)
```
### Authorization Credentials & API Key Management
The function `scythe_set_key()` manages API keys using the [`keyring`](https://github.com/r-lib/keyring) package. `keyring` uses your operating system's credential store to securely keep track of key-value pairs. Running `scythe_set_key()` for the first time will prompt you to set a password for your keyring, should you need to lock or unlock it.
#### Scopus
To obtain a Scopus API key, make an account at the [Elseviers Developers Portal](https://dev.elsevier.com/) and create API key. Once you've obtained your key, you can use `scythe_set_key()` to securely set your key. This key is accessed in the `citation_search()` function, but you can also retrieve the value using `keyring::key_get()`.
```
scythe_set_key(source = "scopus", secret = "YOUR_KEY")
keyring::key_get("scopus", keyring = "scythe")
```
#### Springer
The Springer Nature API key is available by creating an application [here](https://dev.springernature.com/) after signing up for an account. The key can be set and retrieved using:
```
scythe_set_key(source = "springer", secret = "YOUR_KEY")
keyring::key_get("springer", keyring = "scythe")
```
## Acknowledgments
Work on this package was supported by:
- NSF-PLR grant #1546024 to M. B. Jones, S. Baker-Yeboah, J. Dozier, M. Schildhauer, and A. Budden
- NSF-PLR grant #2042102 to M. B. Jones, A. Budden, M. Schildhauer, and J. Dozier
[](https://www.nceas.ucsb.edu)
[](https://www.dataone.org)