mthd_ingest.R

#' 
#' Ingest data
#' @name ingest-Ready4useRepos
#' @description ingest method applied to Ready4useRepos
#' @param x An object of class Ready4useRepos
#' @param fls_to_ingest_chr Files to ingest (a character vector), Default: 'NA'
#' @param gh_token_1L_chr Github token (a character vector of length one), Default: ''
#' @param key_1L_chr Key (a character vector of length one), Default: NULL
#' @param metadata_1L_lgl Metadata (a logical vector of length one), Default: T
#' @param type_1L_chr Type (a character vector of length one), Default: 'R'
#' @return Ingest (an output object of multiple potential types)
#' @rdname ingest-methods
#' @aliases ingest,Ready4useRepos-method
#' @export 
#' @importFrom dataverse get_dataset
#' @importFrom stringi stri_replace_last_regex stri_replace_all_regex
#' @importFrom purrr map map_chr
#' @importFrom ready4 get_rds_from_dv ingest
#' @importFrom stats setNames
#' @importFrom piggyback pb_download_url
#' @importFrom fs path_file
methods::setMethod("ingest", "Ready4useRepos", function (x, fls_to_ingest_chr = NA_character_, gh_token_1L_chr = "", 
    key_1L_chr = NULL, metadata_1L_lgl = T, type_1L_chr = "R") 
{
    ingest_ls <- NULL
    descriptions_chr <- character(0)
    if (!is.na(x@dv_ds_nm_1L_chr)) {
        if (identical(x@dv_ds_metadata_ls[[1]], list())) {
            ds_ls <- dataverse::get_dataset(x@dv_ds_nm_1L_chr, 
                key = key_1L_chr, server = x@dv_server_1L_chr)
            x@dv_ds_metadata_ls <- list(ds_ls = ds_ls)
        }
        else {
            ds_ls <- x@dv_ds_metadata_ls$ds_ls
        }
        if (type_1L_chr == "R") {
            if (is.na(x@fl_nms_chr)) {
                fl_nms_chr <- ds_ls$files$filename %>% get_fl_nms_of_types(types_chr = c(".RDS", 
                  ".Rds", ".rds"))
            }
            else {
                fl_nms_chr <- x@fl_nms_chr
            }
            fl_nms_chr <- fl_nms_chr %>% stringi::stri_replace_last_regex("\\.RDS", 
                "") %>% stringi::stri_replace_last_regex("\\.Rds", 
                "") %>% stringi::stri_replace_last_regex("\\.rds", 
                "")
            if (!is.na(fls_to_ingest_chr[1])) 
                fl_nms_chr <- intersect(fl_nms_chr, fls_to_ingest_chr)
            if (is.na(x@dv_url_pfx_1L_chr)) {
                dv_url_pfx_1L_chr <- character(0)
            }
            else {
                dv_url_pfx_1L_chr <- x@dv_url_pfx_1L_chr
            }
            if (!identical(fl_nms_chr, character(0))) 
                ingest_ls <- purrr::map(fl_nms_chr, ~ready4::get_rds_from_dv(file_nm_1L_chr = .x, 
                  dv_ds_nm_1L_chr = x@dv_ds_nm_1L_chr, dv_url_pfx_1L_chr = dv_url_pfx_1L_chr, 
                  key_1L_chr = key_1L_chr, server_1L_chr = x@dv_server_1L_chr)) %>% 
                  stats::setNames(fl_nms_chr) %>% append(ingest_ls)
        }
        descriptions_chr <- fl_nms_chr %>% purrr::map_chr(~get_fl_meta_from_dv_ls(ds_ls, 
            fl_nm_1L_chr = .x))
    }
    if (!is.na(x@gh_repo_1L_chr)) {
        dmt_urls_chr <- piggyback::pb_download_url(repo = x@gh_repo_1L_chr, 
            tag = x@gh_tag_1L_chr, .token = gh_token_1L_chr)
        if (type_1L_chr == "R") {
            dmt_urls_chr <- dmt_urls_chr %>% get_fl_nms_of_types(types_chr = c(".RDS", 
                ".Rds", ".rds"))
            fl_nms_chr <- dmt_urls_chr %>% fs::path_file()
            fl_nms_chr <- fl_nms_chr %>% stringi::stri_replace_all_regex("\\.RDS", 
                "") %>% stringi::stri_replace_all_regex("\\.Rds", 
                "") %>% stringi::stri_replace_all_regex("\\.rds", 
                "")
            if (!is.na(fls_to_ingest_chr[1])) {
                selected_chr <- intersect(fl_nms_chr, fls_to_ingest_chr)
                idcs_int <- which(fl_nms_chr %in% selected_chr)
            }
            else {
                idcs_int <- 1:length(fl_nms_chr)
            }
            fl_nms_chr <- fl_nms_chr[idcs_int]
            if (!identical(fl_nms_chr, character(0))) 
                ingest_ls <- purrr::map(dmt_urls_chr[idcs_int], 
                  ~readRDS(url(.x))) %>% stats::setNames(fl_nms_chr) %>% 
                  append(ingest_ls)
            descriptions_chr <- c(descriptions_chr, rep(NA_character_, 
                length(fl_nms_chr)))
        }
    }
    y <- Ready4useIngest(objects_ls = ingest_ls, descriptions_chr = descriptions_chr)
    z <- Ready4useRecord(a_Ready4usePointer = Ready4usePointer(b_Ready4useRepos = x), 
        b_Ready4useIngest = y)
    if (!metadata_1L_lgl) {
        ingest_xx <- y@objects_ls
        if (!is.na(fls_to_ingest_chr[1]) & length(fls_to_ingest_chr) == 
            1) 
            ingest_xx <- y %>% procure(fl_nm_1L_chr = fls_to_ingest_chr)
    }
    else {
        ingest_xx <- z
    }
    return(ingest_xx)
})