R/widget-proposal-stage-transition.R

In cwolfsonseeley/discoveryengine: A CADS Prospecting Tool

#' Find proposals that had the given stage transition during a given time period
#'
#' \code{proposal_qualified} just looks for transitions between
#' \code{QU} and any of \code{(CU, SP, PD, GS, DS)}. Similarly,
#' \code{proposal_disqualified} looks for transitions from
#' \code{QU} to \code{(TD, DQ)}. \code{proposal_stage_transition} allows you
#' to specify other types of transitions that might be of interest.
#'
#' @param from_stages character vector of one or more stages
#' @param to_stages character vector of one or more stages
#' @param from_date daterange in YYYYMMDD format
#' @param to_date daterange in YYYYMMDD format
#' @param from daterange in YYYYMMDD format
#' @param to daterange in YYYYMMDD format
#'
#' @examples
#' ## successful QUs during FY18
#' proposal_qualified(from = 20170701, to = 20180630)
#'
#' ## this would do the same thing
#' proposal_stage_transition(from_stages = "QU",
#'                           to_stages = c("CU", "SP", "PD", "GS", "DS"),
#'                           from_date = 20170701, to_date = 20180630)
#'
#' ## from_stages and to_stages are optional, so to find
#' ## proposals that were *ever* in QU:
#' proposal_stage_transition(from_stages = "QU",
#'                           from_date = 20170701, to_date = 20180630)
#'
#' @export
proposal_stage_transition <- function(from_stages = NULL, to_stages = NULL,
                                      from_date = NULL, to_date = NULL) {
    dates <- daterange("stage_transition_date", from = from_date, to = to_date)
    from_stage_switch <- string_switch("stage_from", from_stages)
    to_stage_switch <- string_switch("stage_to", to_stages)

    widget_builder_custom(
        custom = proposal_query(),
        id_field = "assignment_id",
        id_type = "assignment_id",
        switches = list(dates, from_stage_switch, to_stage_switch,
                        string_switch("assigned_at_transition", "Y"))
    )
}