-
Notifications
You must be signed in to change notification settings - Fork 6
/
README.Rmd
138 lines (92 loc) · 8.47 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
125
126
127
128
129
130
131
132
133
134
135
136
137
138
---
fig_caption: yes
---
# refsplitr <img src="man/figures/logo.png" align="right" height="68" />
<!-- badges: start -->
[](http://www.repostatus.org/#active)
[](https://github.com/ropensci/onboarding/issues/256)
[](https://coveralls.io/github/ropensci/refsplitr?branch=master)
[](https://joss.theoj.org/papers/3e46a4970fea0da996251617d2fa85ca)
[](https://github.com/embruna/refsplitr/actions)
<!-- badges: end -->
refsplitr: author name disambiguation, author georeferencing, and mapping of coauthorship networks with Web of Science data.
refsplitr (v1.0) is an R package to parse and organize reference records downloaded from the Web of Science citation database, disambiguate the names of authors, geocode their locations, and generate/visualize coauthorship networks. The WOS is a toll-access literature and citation database maintained by Clarivate Analytics that indexes articles from \~12,000 academic journals. WOS records include a diversity of data about each article (e.g., article title, journal name, author names, author addresses, number of times the article has been cited, funding sources), making them very useful for studying patterns of scientific productivity, coauthorship, research impact, and other Science of Science topics. Because bulk WOS records and API access to the WOS are very expensive, researchers at WOS-subscribing institutions often gather data by conducting WOS searches and downloading reference records in batches. However, this requires a cumbersome process of extracting, merging, and correcting data from the downloaded records prior to conducting any analyses. refsplitr will rapidly merge and process reference data files downloaded from the WOS, and then process and organize them in a format amenable for use in scientometric, social network, and Science of Science analyses.
Support for the development of refsplitr was provided by grants from the [University of Florida Center for Latin American Studies](http://www.latam.ufl.edu/) and the [University of Florida Informatics Institute](https://informatics.institute.ufl.edu/).
## Installation
You can install the development version from [GitHub](https://github.com/) with:
``` r
# install.packages("devtools")
devtools::install_github("ropensci/refsplitr")
```
## Workflow
There are four steps in the `refsplitr` package's workflow:
1. Importing and tidying Web of Science reference records (be sure to download records using the procedure in Appendix 1 of the [vignette](https://docs.ropensci.org/refsplitr/articles/refsplitr.html))
2. Author name disambiguation and parsing of author addresses
3. Georeferencing of author institutions. (*Important Note*: Google has changed its API requirements, which means users now have register with Google prior to georeferencing. For additional details see the [`ggmap`](https://github.com/dkahle/ggmap) repository and the instructions below.)
4. Data visualization
The procedures required for these four steps,each of which is implemented with a simple command, are described in detail in the `refsplitr` [vignette](https://docs.ropensci.org/refsplitr/articles/refsplitr.html). An example of this workflow is provided below:
```{r example1, eval=FALSE}
# load the Web of Science records into a dataframe
dat1 <- references_read(data = system.file("extdata", "example_data.txt", package = "refsplitr"), dir = FALSE)
# disambiguate author names and parse author address
dat2 <- authors_clean(references = dat1)
# after revieiwng disambiguation, merge any necessary corrections
dat3 <- authors_refine(dat2$review, dat2$prelim)
# georeference the author locations
dat4 <- authors_georef(dat3)
# generate a map of coauthorships; this is only one of the five possible visualizations
plot_net_address(dat4$addresses)
```
## Registering with Google for an API key
1. Install and load the `ggmap` package
```{r example2, eval=FALSE}
install.packages("ggmap")
library(ggmap)
```
1. Register for a Google [Geocoding API](https://developers.google.com/maps/documentation/geocoding/overview) by following the instructions on the `READ ME` of the [`ggmap`](https://github.com/dkahle/ggmap) repository.
2. Once you have your API key, add it to your `~/.Renviron` with the following:
```{r example3, eval=FALSE}
`ggmap::register_google(key = "[your key]", write = TRUE)`
```
3. You should now be able to use `authors_georef()` as described in the vignette. **WARNING:** `refsplitr` currently has a limit of 2500 API calls per day. We are working on including the ability for users to select their own limits.
***Remember***: Your API key is unique and for you alone. Don't share it with other users or record it in a script file that is saved in a public repository. If need be you can visit the same website where you initially registered and generate a new key.
## Improvements & Suggestions
We welcome any suggestions for package improvement or ideas for features to include in future versions. We welcome any suggestions for package improvement or ideas for features to include in future versions. If you have suggestions, [here is how to contribute](https://github.com/ropensci/refsplitr/blob/master/CONTRIBUTING.md). We expect everyone contributing to the package to abide by our [Code of Conduct](https://github.com/ropensci/refsplitr/blob/master/CODE_OF_CONDUCT.md).
<center>
<img src="man/figures/coauthor_connections_BITR.png" height="400">
</center>
<center>
Map of georeferenced article coauthorships generated with refsplitr.
</center>
## Contributors
- [Auriel Fournier](https://github.com/aurielfournier), Porzana Solutions
- [Matt Boone](https://github.com/birderboone), Porzana Solutions
- [Forrest Stevens](http://forreststevens.com/teaching/research.html), University of Louisville
- [Emilio M. Bruna](https://github.com/embruna), University of Florida
## Citation
The Refsplitr package has been described in an article in the [_Journal of Open Source Software_](https://joss.theoj.org/papers/10.21105/joss.02028). We request that you cite both the package and the publication when using Refsplitr in your work.
### Citation: Refsplitr Package
Fournier, Auriel M.V., Matthew E. Boone, Forrest R. Stevens, and Emilio M. Bruna (2020). refsplitr: author name disambiguation, author georeferencing, and mapping of coauthorship networks with Web of Science data. R package version 1.0.1. <https://github.com/ropensci/refsplitr>
@Manual{refsplitr2020,
title = {refsplitr: author name disambiguation, author georeferencing,
and mapping of coauthorship networks with Web of Science data.},
author = {Fournier, Auriel M.V., Matthew E. Boone, Forrest R. Stevens,
and Emilio M. Bruna},
year = {2020},
note = {R package version 1.0.1.},
url ={https://github.com/ropensci/refsplitr}
}
### Citation: _JOSS_ paper
Fournier et al., (2020). refsplitr: Author name disambiguation, author georeferencing, and mapping of coauthorship networks with Web of Science data. Journal of Open Source Software, 5(45), 2028, https://doi.org/10.21105/joss.02028
@article{Fournier2020, doi = {10.21105/joss.02028},
url = {https://doi.org/10.21105/joss.02028},
year = {2020}, publisher = {The Open Journal},
volume = {5},
number = {45},
pages = {2028},
author = {Auriel M.v. Fournier and Matthew E. Boone and Forrest R. Stevens and Emilio M. Bruna},
title = {refsplitr: Author name disambiguation, author georeferencing, and mapping of coauthorship networks with Web of Science data},
journal = {Journal of Open Source Software}
}
*Note regarding early package development*: The early development of refsplitr - initially known as refnet - was by Forrest Stevens and Emilio M. Bruna and was on [r-forge](https://r-forge.r-project.org/projects/refnet/). In December 2017 Bruna moved it to Github and hired [Porzana Solutions](https://github.com/aurielfournier) to finalize the package and prepare it for submission to CRAN. *Please make all suggestions for changes via this Github repository - do not* make a repo mirror of the R-forge version.
[](https://ropensci.org)