diff --git a/DESCRIPTION b/DESCRIPTION index e800fde..64907a4 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,6 +1,6 @@ Package: dashboard Title: What the Package Does (One Line, Title Case) -Version: 0.1.3 +Version: 0.1.3.001 Authors@R: person(given = "First", family = "Last", diff --git a/R/editors.R b/R/editors.R index 1bda5f8..9a92bda 100644 --- a/R/editors.R +++ b/R/editors.R @@ -6,7 +6,7 @@ #' @return (Invisibly) A `data.frame` with one row per editor and some key #' statistics. #' @noRd -editor_gh_data <- function (quiet = FALSE, aggregation_period = "quarter") { +editor_gh_data <- function (aggregation_period = "quarter", quiet = FALSE) { aggregation_period <- match.arg ( aggregation_period, @@ -297,12 +297,23 @@ editor_reviews <- function (assignees, number, titles, state, #' Generate a summary report of current state of all rOpenSci editors #' +#' @param aggregation_period The time period for aggregation of timeline for +#' editorial loads. Must be one of "month", "quarter", or "semester". #' @param quiet If `FALSE`, display progress information on screen. #' @return A `data.frame` with one row per issue and some key statistics. #' @export -editor_status <- function (quiet = FALSE) { - dat <- m_editor_gh_data (quiet = quiet) +editor_status <- function (quiet = FALSE, aggregation_period = "quarter") { + + aggregation_period <- match.arg ( + aggregation_period, + c ("month", "quarter", "semester") + ) + + dat <- m_editor_gh_data ( + aggregation_period = aggregation_period, + quiet = quiet + ) dat$latest$status <- "FREE" dat$latest$status [dat$latest$state == "OPEN"] <- "BUSY" diff --git a/codemeta.json b/codemeta.json index f6c6240..318530c 100644 --- a/codemeta.json +++ b/codemeta.json @@ -6,7 +6,7 @@ "name": "dashboard: What the Package Does (One Line, Title Case)", "codeRepository": "https://github.com/ropensci-review-tools/dashboard", "license": "https://spdx.org/licenses/MIT", - "version": "0.1.3", + "version": "0.1.3.001", "programmingLanguage": { "@type": "ComputerLanguage", "name": "R", diff --git a/man/editor_status.Rd b/man/editor_status.Rd index 3288c6b..74954aa 100644 --- a/man/editor_status.Rd +++ b/man/editor_status.Rd @@ -4,10 +4,13 @@ \alias{editor_status} \title{Generate a summary report of current state of all rOpenSci editors} \usage{ -editor_status(quiet = FALSE) +editor_status(quiet = FALSE, aggregation_period = "quarter") } \arguments{ \item{quiet}{If `FALSE`, display progress information on screen.} + +\item{aggregation_period}{The time period for aggregation of timeline for +editorial loads. Must be one of "month", "quarter", or "semester".} } \value{ A `data.frame` with one row per issue and some key statistics.