R/S3_classes_ccmpp_input_df_utility_functions.R

In markalava/ccmppWPP: Cohort Component Population Projection

###-----------------------------------------------------------------------------
### * Subset

#' @rdname subset_demog_change_component_df
#' @export
subset_indicator.ccmpp_input_df <- function(x, indicators, include = TRUE) {

    x <- NextMethod()
    return(ccmpp_input_df(x,
                          value_type = value_type(x)))
}

#' @rdname subset_demog_change_component_df
#' @export
subset_time.ccmpp_input_df <- function(x, times, include = TRUE) {

    x <- NextMethod()
    return(ccmpp_input_df(x,
                          value_type = value_type(x)))
}

#' @rdname subset_demog_change_component_df
#' @export
subset_age.ccmpp_input_df <- function(x, ages, include = TRUE) {

    x <- NextMethod()
    return(ccmpp_input_df(x,
                          value_type = value_type(x)))
}

#' @rdname subset_demog_change_component_df
#' @export
subset_sex.ccmpp_input_df <- function(x, sexes, include = TRUE) {

    x <- NextMethod()
    return(ccmpp_input_df(x,
                          value_type = value_type(x)))
}

###-----------------------------------------------------------------------------
### * Transformations

#' Change the span of a \code{ccmpp_input_df} object
#'
#' This is a generic function with methods for the various sub-classes
#' of \code{ccmpp_input_df}. Valid objects inheriting from
#' \code{ccmpp_input_df} have a common value for \dQuote{age_span} and
#' \dQuote{time_span}. This function provides a way of coherently
#' changing this value, ensuring that the result is still a valid
#' member of its class.
#'
#' @param x An object inheriting from \code{\link{ccmpp_input_df}}.
#' @param value A numeric scalar for the new span.
#' @param ... Passed to or from other methods.
#' @return \code{x} with spans set to \code{value}.
#' @name change_ccmpp_input_df_span
#' @author Mark Wheldon
#' @export
`span<-` <- function(x, value, ...) {
    UseMethod("span<-")
}

#' @rdname change_ccmpp_input_df_span
#' @export
`span<-.ccmpp_input_df` <- function(x, value, ...) {
    ## Use the 'abridge' function
    stop("Not yet implemented")
}