R/C3_youthvars_k6.R

In ready4-dev/youthvars: Describe and Validate Youth Mental Health Economic Datasets

#' youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @description Create a new valid instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @param x A prototype for the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores, Default: make_pt_youthvars_k6()
#' @return A validated instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @details youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @rdname youthvars_k6
#' @export 
youthvars_k6 <- function(x = make_pt_youthvars_k6()){ 
validate_youthvars_k6(make_new_youthvars_k6(x))
}
#' make new youthvars K-6 youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @description Create a new unvalidated instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @param x A prototype for the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @return An unvalidated instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @details youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @rdname make_new_youthvars_k6
#' @export 
#' @keywords internal
make_new_youthvars_k6 <- function(x){ 
stopifnot(is.integer(x))
class(x) <- append(c("youthvars_k6",setdiff(make_pt_youthvars_k6() %>% class(),class(x))),
class(x))
x
}
#' make prototype youthvars K-6 youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores

#' @return A prototype for youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' 
#' @rdname youthvars_k6
#' @export 
make_pt_youthvars_k6 <- function(){ 
integer(0)
}
#' validate youthvars K-6 youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @description Validate an instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @param x An unvalidated instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @return A prototpe for youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @details youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @rdname validate_youthvars_k6
#' @export 
#' @keywords internal
validate_youthvars_k6 <- function(x){
if(any(x[!is.na(x)] < 0)){
stop("All non-missing values in valid youthvars_k6 object must be greater than or equal to 0.",
call. = FALSE)
}

 if(any(x[!is.na(x)] > 24)){
stop("All non-missing values in valid youthvars_k6 object must be less than or equal to 24.",
call. = FALSE)
}

x}
#' is youthvars K-6 youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' @param x An object of any type
#' @return A logical value, TRUE if a valid instance of the youthvars ready4 sub-module (S3 class) for Kessler Psychological Distress Scale (K6) - US Scoring System scores
#' 
#' @rdname youthvars_k6
#' @export 
is_youthvars_k6 <- function(x) inherits(validate_youthvars_k6(x), "youthvars_k6")