-
Notifications
You must be signed in to change notification settings - Fork 13
/
README.Rmd
69 lines (41 loc) · 2.36 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
---
output: github_document
---
```{r knitr.opts, echo = FALSE, message = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-"
)
```
# nihexporter
<!-- badges: start -->
[![R-CMD-check](https://github.com/rnabioco/nihexporter/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/rnabioco/nihexporter/actions/workflows/R-CMD-check.yaml)
<!-- badges: end -->
The `nihexporter` R package provides a minimal set of data from the [NIH EXPORTER](https://reporter.nih.gov/exporter) database, which contains information on NIH biomedical research funding from 1985-2021.
To keep the package lightweight, many details are omitted but can be easily retrieved from [NIH RePORTER](https://reporter.nih.gov/).
## Installation
Install the package from github with:
``` r
# install.packages('pak')
pak::pkg_install("jayhesselberth/nihexporter")
```
**Note: this is a large data package (>40 Mb)**
## Tables
* `projects`: provides data on funded projects by NIH.
* `project_pis`: links project numbers (`project.num`) to principal investigator IDs (`pi.id`).
* `publinks`: links Pubmed IDs (`pmid`) to project numbers (`project.num`).
* `publications`: provides information for individual publications, including their [Relative Citation Ratio](https://icite.od.nih.gov) values (`rcr`).
* `patents`: links project IDs (`project.num`) to `patent.id`.
* `clinical_studies`: links project IDs to associated [clinical trials](https://clinicaltrials.gov/).
* `project_io`: pre-computed `n.pubs`, `n.patents` and `project.cost` for each `project.num`.
**Note:** [Abstracts](https://exporter.nih.gov/ExPORTER_Catalog.aspx?sid=0&index=1) from NIH EXPORTER are not provided as they significantly increase the size of the package.
## Functions
* `rcr()` retrieves [Relative Citation Ratios](https://icite.od.nih.gov/) and associated information for PubMed IDs.
* `nihexporter_sqlite()` can be used to cache data in a local SQLite database.
## Variables
* `nih.institutes`: 27 NIH institutes in two-letter format
## Resources
+ [`nihexporter` pre-print on bioRxiv](https://biorxiv.org/content/early/2015/12/02/033456)
+ [RePORTER / EXPORTER mailing list archives](https://list.nih.gov/cgi-bin/wa.exe?A0=NIH-REPORT-PUBLIC-L)
+ [Relative Citation Ratio manuscript at PLoS](https://journals.plos.org/plosbiology/article?id=10.1371/journal.pbio.1002541)