R/S3_classes_ccmpp_input_mort_rate_df.R

In markalava/ccmppWPP: Cohort Component Population Projection

#' Low-level constructor for class \code{mort_rate_age_sex}.
#'
#' @description
#' Creates an object of class \code{mort_rate_age_sex}. Minimal
#' checks are done; for interactive use see
#' \code{\link{mort_rate_age_sex}}.
#'
#' This function is not exported. The user-level constructor is
#' \code{\link{mort_rate_age_sex}}.
#'
#' @seealso mort_rate_age_sex
#'
#' @inheritParams new_demog_change_component_df
#'
#' @return An object of class \code{mort_rate_age_sex}.
#' @author Mark Wheldon
new_mort_rate_age_sex <-
    function(x,
             age_span = double(),
             time_span = double(),
             non_zero_fert_ages = double(),
             dimensions = get_req_dimensions_for_subclass_classes("mort_rate_age_sex"),
             value_type = get_value_types_for_subclass_classes("mort_rate_age_sex"),
             value_scale = NA,
             ..., class = character()) {
        new_ccmpp_input_df(x = x,
                           age_span = age_span,
                           time_span = time_span,
                           dimensions = dimensions,
                           value_type = value_type,
                           value_scale = value_scale,
                           ...,
                           class = c(class, "mort_rate_age_sex"))
    }


#' Constructor for class \code{mort_rate_age_sex}
#'
#' \code{mort_rate_age_sex} is a subclass of
#' \code{\link{ccmpp_input_df}}. It imposes two additional conditions:
#' \enumerate{
#'   \item{\code{Value_type} attribute equals \dQuote{proportion}.}
#'   \item{Within year and sex, age must start at 0.}}
#'
#' Methods are defined for \code{\link{data.frame}}s and
#' \code{\link{ccmpp_input_list}}s, and possibly other objects as
#' well. The \code{data.frame} method \dQuote{constructs} an object
#' from \code{x}. The \code{ccmpp_input_list} method \dQuote{extracts}
#' an object from \code{x}. There is also a replacement function which
#' complements the extraction methods.
#'
#' @family ccmpp_input_objects
#' @seealso \code{\link{validate_ccmppWPP_object}} for object validation,
#'     \code{\link{ccmpp_input_df}} for the class from which this one
#'     inherits.
#'
#' @param x An object for which a method is defined (see \dQuote{Details}).
#' @inheritParams demog_change_component_df
#' @return An object of class \code{mort_rate_age_sex}.
#' @author Mark Wheldon
#' @export
mort_rate_age_sex <- function(x, ...) {
    UseMethod("mort_rate_age_sex")
}

#' @rdname mort_rate_age_sex
#' @export
mort_rate_age_sex.data.frame <- function(x) {
        li <- prepare_df_for_ccmpp_input_df(x,
                           dimensions = get_req_dimensions_for_subclass_classes("mort_rate_age_sex"),
                           value_type = get_value_types_for_subclass_classes("mort_rate_age_sex"),
                           value_scale = NA)

        ## Create/Validate
        validate_ccmppWPP_object(
            new_mort_rate_age_sex(li$df,
                               age_span = li$age_span,
                               time_span = li$time_span,
                               value_scale = NA)
        )
}

#' @rdname mort_rate_age_sex
#' @export
mort_rate_age_sex.life_table_age_sex <- function(x) {
    mort_rate_component(x)
}

#' @rdname mort_rate_age_sex
#' @export
mort_rate_age_sex.ccmpp_input_list <- function(x) {
    mort_rate_component(x)
}

#' @rdname mort_rate_age_sex
#' @export
`mort_rate_age_sex<-` <- function(x, value) {
    `mort_rate_component<-`(x, value)
}


#' Coerce to a \code{mort_rate_age_sex}
#'
#' These functions coerce an object to a
#' \code{mort_rate_age_sex} if possible, or check if it is
#' one.
#'
#' @seealso \code{\link{coerce_demog_change_component_df}} for an important note on validation.
#'
#' @inheritParams coerce_demog_change_component_df
#' @return A coerced object in the case of the \code{as_...}
#'     functions; a logical for the \code{is_...} functions.
#' @author Mark Wheldon
#' @name coerce_mort_rate_age_sex
#' @export
as_mort_rate_age_sex <- function(x, ...) {
    UseMethod("as_mort_rate_age_sex")
}

#' @rdname coerce_mort_rate_age_sex
#' @export
as_mort_rate_age_sex.default <- function(x, ...) {
    if (is_mort_rate_age_sex(x)) return(x)
    stop("Cannot coerce 'x' to 'mort_rate_age_sex'.")
}

#' @rdname coerce_mort_rate_age_sex
#' @export
as_mort_rate_age_sex.data.frame <- function(x, ...) {
    mort_rate_age_sex(as.data.frame(x))
}

#' @rdname coerce_mort_rate_age_sex
#' @export
as_mort_rate_age_sex.matrix <- function(x, ...) {
    as_mort_rate_age_sex(as.data.frame(NextMethod()))
}

#' @rdname coerce_mort_rate_age_sex
#' @export
as_mort_rate_age_sex.mort_rate_age_sex <- function(x, ...) {
    ## copied from  'as.data.frame'
    cl <- oldClass(x)
    i <- match("mort_rate_age_sex", cl)
    if (i > 1L)
        class(x) <- cl[-(1L:(i - 1L))]
    return(validate_ccmppWPP_object(x))
}

#' @rdname coerce_mort_rate_age_sex
#' @export
is_mort_rate_age_sex <- function(x) {
    inherits(x, "mort_rate_age_sex")
}



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

    x <- NextMethod()
    return(mort_rate_age_sex(x))
}

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

    x <- NextMethod()
    return(mort_rate_age_sex(x))
}

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

    x <- NextMethod()
    return(mort_rate_age_sex(x))
}