Title: Download Logs from the 'RStudio' 'CRAN' Mirror
Version: 2.1.1
Description: 'API' to the database of 'CRAN' package downloads from the 'RStudio' 'CRAN mirror'. The database itself is at http://cranlogs.r-pkg.org, see https://github.com/r-hub/cranlogs.app for the raw 'API'.
License: MIT + file LICENSE
URL: https://github.com/r-hub/cranlogs, https://r-hub.github.io/cranlogs
BugReports: https://github.com/r-hub/cranlogs/issues
Imports: httr, jsonlite
Encoding: UTF-8
RoxygenNote: 6.1.1
Suggests: testthat
NeedsCompilation: no
Packaged: 2019-04-29 12:53:53 UTC; gaborcsardi
Author: Gábor Csárdi [aut, cre], R Consortium [fnd]
Maintainer: Gábor Csárdi <csardi.gabor@gmail.com>
Repository: CRAN
Date/Publication: 2019-04-29 19:30:07 UTC

cranlogs: Download Logs from the 'RStudio' 'CRAN' Mirror

Description

'API' to the database of 'CRAN' package downloads from the 'RStudio' 'CRAN mirror'. The database itself is at <http://cranlogs.r-pkg.org>, see <https://github.com/r-hub/cranlogs.app> for the raw 'API'.

Author(s)

Maintainer: Gábor Csárdi csardi.gabor@gmail.com

Other contributors:

See Also

Useful links:

Daily package downloads from the RStudio CRAN mirror

Description

Daily package downloads from the RStudio CRAN mirror

Usage

cran_downloads(packages = NULL, when = c("last-day", "last-week",
  "last-month"), from = "last-day", to = "last-day")

Arguments

packages

A character vector, the packages to query, or NULL for a sum of downloads for all packages. Alternatively, it can also be "R", to query downloads of R itself. "R" cannot be mixed with packages.

when

last-day, last-week or last-month (see details). If this is given, then from and to are ignored.

from

Start date, in yyyy-mm-dd format, or last-day. It is ignored if when is given.

to

End date, in yyyy-mm-dd format, or last-day. It is ignored if when is given.

Details

last-day is the last day for which data is available, last-week is from 6 days prior to that last day with data, last-month is from 29 days prior to that last day with data.

0 counts can be due to the non-availability of data on the RStudio server for that day.

Value

For packages a data frame with columns:

package

The package. This column is missing if all packages were queried.

date

Day of the downloads, it is a Date object.

count

Download count.

For downloads of R, there are also columns for the operating system (os) and the R version (version).

See Also

Other CRAN downloads: cran_top_downloads

Examples

## Not run: 
## Default is last day for which data is available.
cran_downloads()

## All downloads for 'dplyr' in the last day for which data is available.
cran_downloads(packages = "dplyr")

## Daily downloads for 'igraph' last week
## (6 days prior to the last day for which data is available)
cran_downloads(packages = "igraph", when = "last-week")

## Downloads in the specified time interval
cran_downloads(from = "2014-06-30", to = "2014-08-08")

## Multiple packages
cran_downloads(packages = c("ggplot2", "plyr", "dplyr"))

## R downloads
cran_downloads("R")

## End(Not run)

Top downloaded packages from the RStudio CRAN mirror

Description

Top downloaded packages from the RStudio CRAN mirror

Usage

cran_top_downloads(when = c("last-day", "last-week", "last-month"),
  count = 10)

Arguments

when

last-day, last-week or last-month (see details).

count

Number of packages to list. Note that the DB server lists only at most 100 packages. This number might change in the future.

Details

last-day is the last day for which data is available, last-week is from 6 days prior to that last day with data, last-month is from 29 days prior to that last day with data.

0 counts can be due to the non-availability of data on the RStudio server for that day.

Value

A data frame with columns: rank, package, count, from, to.

See Also

Other CRAN downloads: cran_downloads

Examples

## Not run: 
## Default is last day for which data is available.
cran_top_downloads()

## Last week (6 days prior to the last day for which data is available) 
## instead
cran_top_downloads(when = "last-week")

## End(Not run)

Create Markdown code for a cranlogs badge

Description

Create Markdown code for a cranlogs badge

Usage

cranlogs_badge(package_name, summary = c("last-month", "last-day",
  "last-week", "grand-total"), color = "blue")

Arguments

package_name

name of the package

summary

One of "last-day", "last-week", "last-month", "grand-total".

color

Either a hex color code or one of "brightgreen", "green", "yellowgreen", "yellow", "orange", "red", "lightgrey", "blue".

Value

The string to be copy-pasted to the README source.

Examples

cranlogs_badge("praise")
cranlogs_badge("praise", summary = "grand-total")
cranlogs_badge("praise", summary = "last-week", color = "orange")
cranlogs_badge("praise", color = "ff8c69")