R/get-cur-pchhai-hosp-data.R

Defines functions current_pch_hai_hospital_data

Documented in current_pch_hai_hospital_data

#' Get Current PCH HAI Hospital Data.
#'
#' @family Hospital Data
#'
#' @author Steven P. Sanderson II, MPH
#'
#' @seealso \url{https://data.cms.gov/provider-data/topics/hospitals/}
#'
#' @description Get the current PCH HAI Hospital data.
#'
#' @details This function will obtain the current PCH HAI Hospital data
#' from the output of the [healthyR.data::current_hosp_data()] function, that is
#' the required input for the `.data` parameter. This function only returns a single
#' object.
#'
#' @param .data The data that results from the `current_hosp_data()` function.
#'
#' @examples
#' \dontrun{
#' current_hosp_data() |>
#'   current_pch_hai_hospital_data()
#' }
#'
#' @return
#' Gets the current PCH HCAHPS data from the current hospital data file.
#'
#' @name current_pch_hai_hospital_data
NULL

#' @export
#' @rdname current_pch_hai_hospital_data

current_pch_hai_hospital_data <- function(.data) {

    # Variables
    l <- .data

    # Checks
    if (!inherits(l, "current_hosp_data")){
        rlang::abort(
            message = "'.data' must come from the function 'current_hosp_data()",
            use_cli_format = TRUE
        )
    }

    # Manipulations
    # Get the exact files necessary to the ASC
    file_names_vec <- c("pch_healthcare_associated_infections_hospital")

    asc_list <- l[names(l) %in% file_names_vec]
    # names(asc_list)[1] <-  "pch_hcahps_facility"

    # Make sure there are no 0 length items
    asc_list <- asc_list[lengths(asc_list) > 0]
    ret <- asc_list

    # Return
    attr(ret, ".list_type") <- "pch_hai_hosp_list"
    class(ret) <- c("pch_hai_hosop_list", class(ret))

    return(ret)

}

Try the healthyR.data package in your browser

Any scripts or data that you put into this service are public.

healthyR.data documentation built on July 4, 2024, 5:07 p.m.