R/fn_get.R

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

#' Get Assessment of Quality of Life Six Dimension scoring datasets
#' @description get_aqol6d_scrg_dss() is a Get function that extracts data from an object. Specifically, this function implements an algorithm to get assessment of quality of life six dimension scoring datasets. The function returns Assessment of Quality of Life Six Dimension scoring datasets (a list).

#' @return Assessment of Quality of Life Six Dimension scoring datasets (a list)
#' @rdname get_aqol6d_scrg_dss
#' @export 
#' @importFrom lifecycle deprecate_soft
#' @importFrom ready4 ingest procureSlot procure
#' @importFrom ready4use Ready4useRepos
#' @keywords internal
get_aqol6d_scrg_dss <- function () 
{
    lifecycle::deprecate_soft("0.0.0.9078", "youthvars::get_aqol6d_scrg_dss()", 
        "scorz::get_aqol6d_scrg_dss()")
    aqol6d_scrg_dss_ls <- ready4::ingest(ready4use::Ready4useRepos(gh_repo_1L_chr = "ready4-dev/scorz", 
        gh_tag_1L_chr = "Documentation_0.0"), fls_to_ingest_chr = c("aqol6d_scrg_dss_ls")) %>% 
        ready4::procureSlot("b_Ready4useIngest") %>% ready4::procure(fl_nm_1L_chr = "aqol6d_scrg_dss_ls")
    return(aqol6d_scrg_dss_ls)
}
#' Get guide box legend
#' @description get_guide_box_lgd() is a Get function that extracts data from an object. Specifically, this function implements an algorithm to get guide box legend. The function returns Legend (a list).
#' @param plot_plt Plot (a plot)
#' @return Legend (a list)
#' @rdname get_guide_box_lgd
#' @export 
#' @importFrom ggplot2 ggplot_gtable ggplot_build
#' @keywords internal
get_guide_box_lgd <- function (plot_plt) 
{
    tmp <- ggplot2::ggplot_gtable(ggplot2::ggplot_build(plot_plt))
    leg <- which(sapply(tmp$grobs, function(x) x$name) == "guide-box")
    legend_ls <- tmp$grobs[[leg]]
    return(legend_ls)
}
#' Get journal palette function
#' @description get_journal_palette_fn() is a Get function that extracts data from an object. Specifically, this function implements an algorithm to get journal palette function. The function returns Journal palette (a function).
#' @param type_1L_chr Type (a character vector of length one), Default: c("colour", "fill")
#' @param what_1L_chr What (a character vector of length one), Default: 'lancet'
#' @return Journal palette (a function)
#' @rdname get_journal_palette_fn
#' @export 
#' @importFrom lifecycle deprecate_soft
#' @importFrom ready4use get_journal_palette_fn
#' @keywords internal
get_journal_palette_fn <- function (type_1L_chr = c("colour", "fill"), what_1L_chr = "lancet") 
{
    lifecycle::deprecate_soft("0.0.0.9127", "youthvars::get_journal_palette_fn()", 
        "ready4use::get_journal_palette_fn()")
    journal_palette_fn <- ready4use::get_journal_palette_fn(type_1L_chr = type_1L_chr, 
        what_1L_chr = what_1L_chr)
    return(journal_palette_fn)
}