Permalink
Browse files

Fix manual errors, add note about max 100 top pkgs

  • Loading branch information...
1 parent ab8b920 commit 10e40e8adf74a1ba3b197995d8425305dcb8eaaf @gaborcsardi gaborcsardi committed May 7, 2015
Showing with 15 additions and 8 deletions.
  1. +7 −4 R/cranlogs.R
  2. +4 −4 man/cran_downloads.Rd
  3. +4 −0 man/cran_top_downloads.Rd
View
@@ -23,10 +23,10 @@ top_url <- paste0(base_url, "top/")
#' @param to End date, in \code{yyyy-mm-dd} format, or
#' \code{last-day}. It is ignored if \code{when} is given.
#' @return A data frame with columns:
-#' \item \code{package} The package. This column is missing if
-#' all packages were queried.
-#' \item \code{date} Day of the downloads, it is a Date object.
-#' \item \code{count} Download count.
+#' \item{\code{package}}{The package. This column is missing if
+#' all packages were queried.}
+#' \item{\code{date}}{Day of the downloads, it is a Date object.}
+#' \item{\code{count}}{Download count.}
#'
#' @family CRAN downloads
#' @export
@@ -118,6 +118,9 @@ fill_in_dates <- function(df, start, end) {
#' Top downloaded packages from the RStudio CRAN mirror
#'
#' @param when \code{last_day}, \code{last_week} or \code{last_month}.
+#' @param count Number of packages to list. Note that the DB server
+#' lists only at most 100 packages. This number might change in the
+#' future.
#' @return A data frame with columns: \code{rank}, \code{package},
#' \code{count}, \code{from}, \code{to}.
#'
View
@@ -22,10 +22,10 @@ If this is given, then \code{from} and \code{to} are ignored.}
}
\value{
A data frame with columns:
- \item \code{package} The package. This column is missing if
- all packages were queried.
- \item \code{date} Day of the downloads, it is a Date object.
- \item \code{count} Download count.
+ \item{\code{package}}{The package. This column is missing if
+ all packages were queried.}
+ \item{\code{date}}{Day of the downloads, it is a Date object.}
+ \item{\code{count}}{Download count.}
}
\description{
Daily package downloads from the RStudio CRAN mirror
@@ -9,6 +9,10 @@ cran_top_downloads(when = c("last-day", "last-week", "last-month"),
}
\arguments{
\item{when}{\code{last_day}, \code{last_week} or \code{last_month}.}
+
+\item{count}{Number of packages to list. Note that the DB server
+lists only at most 100 packages. This number might change in the
+future.}
}
\value{
A data frame with columns: \code{rank}, \code{package},

0 comments on commit 10e40e8

Please sign in to comment.