README.Rmd

---
output:
  github_document:
    html_preview: false
---

<!-- README.md is generated from README.Rmd. Please edit that file -->

```{r, setup, echo = FALSE, message = FALSE}
knitr::opts_chunk$set(
  comment = "#>",
  tidy = FALSE,
  error = FALSE)
```

# cranlogs <a href='https://r-hub.github.io/cranlogs'><img src='man/figures/logo.png' align="right" height="138.5" /></a>

> Download logs from the RStudio CRAN mirror

<!-- badges: start -->
[![Linux Build Status](https://travis-ci.org/r-hub/cranlogs.svg?branch=master)](https://travis-ci.org/r-hub/cranlogs)
[![Windows Build status](https://ci.appveyor.com/api/projects/status/github/metacran/cranlogs?svg=true)](https://ci.appveyor.com/project/gaborcsardi/cranlogs)
[![CRAN version](http://www.r-pkg.org/badges/version/cranlogs)](http://www.r-pkg.org/pkg/cranlogs)
[![CRAN RStudio mirror downloads](http://cranlogs.r-pkg.org/badges/cranlogs)](http://www.r-pkg.org/pkg/cranlogs)
[![cran checks](https://cranchecks.info/badges/worst/cranlogs)](https://cranchecks.info/pkgs/cranlogs)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
[![Gitter chat](https://badges.gitter.im/gitterHQ/gitter.png)](https://gitter.im/r-hub/community)
<!-- badges: end -->

[RStudio](http://www.rstudio.com) publishes the download logs from
their CRAN package mirror daily at http://cran-logs.rstudio.com.

This R package queries a [web API maintained by R-hub](https://github.com/r-hub/cranlogs.app#the-api-of-the-cran-downloads-database) serving a database, also maintained by R-hub, that contains the daily download
numbers for each package.

The RStudio CRAN mirror is not the only CRAN mirror, but it's a popular
one: it's the default choice for RStudio users. The actual number of
downloads over all CRAN mirrors is unknown.

## Installation

You can install `cranlogs` from CRAN:

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

Or get the development version from Github:

```{r eval = FALSE}
# install.packages("remotes")
remotes::install_github("r-hub/cranlogs")
```

## Usage

It has a very simple API. By default it shows the total number of
package downloads from the last day for which data is available.

```{r}
library(cranlogs)
cran_downloads()
```

The last week (6 days prior to the last day for which data is available),
or the last month (29 days prior to the last day for which data is
available) can be also easily queried:

```{r}
cran_downloads(when = "last-week")
```

The `package` argument queries a specific package:

```{r}
cran_downloads(when = "last-week", package = c("magrittr", "dplyr"))
```

Alternative intervals can also be specified:

```{r}
cran_downloads(package = "plyr", from = "2014-01-01", to = "2014-02-01")
```

For downloads of R itself, give `"R"` instead of a package:

```{r}
cran_downloads("R")
```

## Top downloaded packages

Last day for which data is available:

```{r}
cran_top_downloads()
```

Last week (6 days prior to the last day for which data is available):

```{r}
cran_top_downloads("last-week")
```

## Raw JSON API

See [the GitHub repo of the API of the CRAN downloads
  database](https://github.com/r-hub/cranlogs.app).