README.rmd

---
title: "wosr"
output: github_document
---

```{r, echo = FALSE, message = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  progress = FALSE,
  error = FALSE, 
  message = FALSE,
  warning = FALSE
)

options(digits = 2)
```

> R clients to the Web of Science and Incites APIs

[![Linux Build Status](https://travis-ci.org/vt-arc/wosr.svg?branch=master)](https://travis-ci.org/vt-arc/wosr) 
[![CRAN version](http://www.r-pkg.org/badges/version/wosr)](https://cran.r-project.org/package=wosr)

## Installation

You can get the stable version from CRAN:

```r
install.packages("wosr")
```

Or the development version from GitHub:

```r
if (!"devtools" %in% rownames(installed.packages())) 
  install.packages("devtools")

devtools::install_github("vt-arc/wosr")
```

## Web of Science

```{r, eval = FALSE}
library(wosr)

# Save your WoS API username and password in environment variables
Sys.setenv(WOS_USERNAME = "your_username", WOS_PASSWORD = "your_password")

# Get session ID
sid <- auth()
```

```{r, echo = FALSE}
library(wosr)
sid <- auth()
```

```{r}
# Query WoS to see how many results match your query
query <- 'TS = ("animal welfare") AND PY = (2002-2003)'
query_wos(query, sid = sid)
```

```{r}
# Download data
pull_wos(query, sid = sid)
```

## InCites

```{r, eval = FALSE}
# Save your InCites developer key in an environment variable
Sys.setenv(INCITES_KEY = "your_key")
```

```{r}
# Vector of UTs (publication identifiers) to get InCites data for
uts <- c("000272272000015", "000272366800025", "000272877700013")

# Download InCites data for those UTs
pull_incites(uts)
```

## Web of Science and InCites

```{r}
# Download WoS data
wos <- pull_wos('TS = ("dog welfare")', sid = sid)

# Download InCites data
head(pull_incites(wos$publication$ut))
```

## Learning more

* To learn more, head over to `wosr`'s [webpage](https://vt-arc.github.io/wosr/index.html).