moved code metadata to pkg dmt from dv

Author: matthewphamilton

.Rbuildignore

@@ -84,3 +84,10 @@
 ^data-raw/TEMP/mthd_ratify\.R$
 ^data-raw/TEMP/mthd_renew\.R$
 ^data-raw/TEMP/mthd_report\.R$
+^data-raw/abbreviations_lup\.Rds$
+^data-raw/fn_types_lup\.Rds$
+^data-raw/object_type_lup\.Rds$
+^data-raw/prototype_lup\.Rds$
+^data-raw/seed_obj_lup_tb\.Rds$
+^data-raw/seed_obj_type_lup\.Rds$
+^data-raw/treat_as_words_chr\.Rds$

NAMESPACE

@@ -35,6 +35,7 @@ export(get_obj_type_new_cses)
 export(get_outp_obj_type)
 export(get_r4_obj_slots)
 export(get_rds_from_dv)
+export(get_rds_from_pkg_dmt)
 export(get_return_obj_nm)
 export(import_xls_sheets)
 export(is_ready4fun_abbreviations)
@@ -255,7 +256,6 @@ importFrom(ready4,authorData)
 importFrom(ready4,authorFunctions)
 importFrom(ready4,get_from_lup_obj)
 importFrom(ready4,get_r4_obj_slots)
-importFrom(ready4,get_rds_from_dv)
 importFrom(ready4,make_list_phrase)
 importFrom(ready4,make_prompt)
 importFrom(ready4,procure)

R/C3_ready4fun_metadata_b.R

@@ -39,6 +39,7 @@ x
 #' @param inc_pkg_meta_data_1L_lgl Include package meta data (a logical vector of length one), Default: logical(0)
 #' @param object_type_lup Object type (a lookup table), Default: ready4fun_abbreviations()
 #' @param path_to_dmt_dir_1L_chr Path to documentation directory (a character vector of length one), Default: character(0)
+#' @param piggyback_to_1L_chr Piggyback to (a character vector of length one), Default: character(0)
 #' @param pkg_dmt_dv_dss_chr Package documentation dataverse datasets (a character vector), Default: character(0)
 #' @param pkg_ds_ls_ls Package dataset (a list of lists), Default: list()
 #' @param seed_obj_type_lup Seed object type (a lookup table), Default: tibble::tibble()
@@ -66,6 +67,7 @@ import_from_chr = character(0),
 inc_pkg_meta_data_1L_lgl = logical(0),
 object_type_lup = ready4fun_abbreviations(),
 path_to_dmt_dir_1L_chr = character(0),
+piggyback_to_1L_chr = character(0),
 pkg_dmt_dv_dss_chr = character(0),
 pkg_ds_ls_ls = list(),
 seed_obj_type_lup = tibble::tibble(),
@@ -87,6 +89,7 @@ import_from_chr = import_from_chr,
 inc_pkg_meta_data_1L_lgl = inc_pkg_meta_data_1L_lgl,
 object_type_lup = object_type_lup,
 path_to_dmt_dir_1L_chr = path_to_dmt_dir_1L_chr,
+piggyback_to_1L_chr = piggyback_to_1L_chr,
 pkg_dmt_dv_dss_chr = pkg_dmt_dv_dss_chr,
 pkg_ds_ls_ls = pkg_ds_ls_ls,
 seed_obj_type_lup = seed_obj_type_lup,

R/db_abbreviations_lup.R

@@ -9,5 +9,5 @@
 #'   \item{long_name_chr}{Long name (a character vector)}
 #'   \item{plural_lgl}{Plural (a logical vector)}
 #' }
-#' @source \url{https://doi.org/10.7910/DVN/2Y9VF9}
+#' @source \url{ready4-dev/ready4}
 "abbreviations_lup"

R/db_fn_types_lup.R

@@ -12,5 +12,5 @@
 #'   \item{is_generic_lgl}{Is generic (a logical vector)}
 #'   \item{is_method_lgl}{Is method (a logical vector)}
 #' }
-#' @source \url{https://doi.org/10.7910/DVN/2Y9VF9}
+#' @source \url{ready4-dev/ready4}
 "fn_types_lup"

R/fn_add.R

@@ -255,14 +255,13 @@ add_lups <- function (template_lup, new_lup, key_var_nm_1L_chr, priority_lup_for
 #' @return Package setup (a list)
 #' @rdname add_new_cls_pts
 #' @export 
-#' @importFrom ready4 get_rds_from_dv add_lups
 #' @importFrom dplyr filter
+#' @importFrom ready4 add_lups
 add_new_cls_pts <- function (pkg_setup_ls, addl_cls_pts_tb = NULL, purge_pkg_clss_1L_lgl = T) 
 {
     if (is.null(pkg_setup_ls$subsequent_ls$prototype_lup)) {
-        pkg_setup_ls$subsequent_ls$prototype_lup <- ready4::get_rds_from_dv("prototype_lup", 
-            dv_ds_nm_1L_chr = pkg_setup_ls$subsequent_ls$dv_ds_nm_1L_chr, 
-            dv_url_pfx_1L_chr = pkg_setup_ls$subsequent_ls$dv_url_pfx_1L_chr)
+        pkg_setup_ls$subsequent_ls$prototype_lup <- get_rds_from_pkg_dmt(pkg_setup_ls, 
+            fl_nm_1L_chr = "prototype_lup")
     }
     if (purge_pkg_clss_1L_lgl) {
         pkg_setup_ls$subsequent_ls$prototype_lup <- pkg_setup_ls$subsequent_ls$prototype_lup %>% 

R/fn_get.R

@@ -24,25 +24,23 @@ get_all_depcys_of_fns <- function (pkg_depcy_ls, fns_chr)
 #' Get argument object type
 #' @description get_arg_obj_type() is a Get function that retrieves a pre-existing data object from memory, local file system or online repository. Specifically, this function implements an algorithm to get argument object type. Function argument argument_nm_1L_chr specifies the where to look for the required object. The function returns Argument object type (a character vector of length one).
 #' @param argument_nm_1L_chr Argument name (a character vector of length one)
-#' @param dv_ds_nm_1L_chr Dataverse dataset name (a character vector of length one), Default: 'https://doi.org/10.7910/DVN/2Y9VF9'
-#' @param dv_url_pfx_1L_chr Dataverse url prefix (a character vector of length one), Default: character(0)
-#' @param key_1L_chr Key (a character vector of length one), Default: NULL
+#' @param dv_ds_nm_1L_chr Dataverse dataset name (a character vector of length one), Default: 'ready4-dev/ready4'
+#' @param dv_url_pfx_1L_chr Dataverse url prefix (a character vector of length one), Default: deprecated()
+#' @param key_1L_chr Key (a character vector of length one), Default: deprecated()
 #' @param object_type_lup Object type (a lookup table), Default: NULL
-#' @param server_1L_chr Server (a character vector of length one), Default: Sys.getenv("DATAVERSE_SERVER")
+#' @param server_1L_chr Server (a character vector of length one), Default: deprecated()
 #' @return Argument object type (a character vector of length one)
 #' @rdname get_arg_obj_type
 #' @export 
-#' @importFrom ready4 get_rds_from_dv
 #' @importFrom dplyr filter mutate pull
 #' @keywords internal
-get_arg_obj_type <- function (argument_nm_1L_chr, dv_ds_nm_1L_chr = "https://doi.org/10.7910/DVN/2Y9VF9", 
-    dv_url_pfx_1L_chr = character(0), key_1L_chr = NULL, object_type_lup = NULL, 
-    server_1L_chr = Sys.getenv("DATAVERSE_SERVER")) 
+get_arg_obj_type <- function (argument_nm_1L_chr, dv_ds_nm_1L_chr = "ready4-dev/ready4", 
+    dv_url_pfx_1L_chr = deprecated(), key_1L_chr = deprecated(), 
+    object_type_lup = NULL, server_1L_chr = deprecated()) 
 {
     if (is.null(object_type_lup)) 
-        object_type_lup <- ready4::get_rds_from_dv("object_type_lup", 
-            dv_ds_nm_1L_chr = dv_ds_nm_1L_chr, dv_url_pfx_1L_chr = dv_url_pfx_1L_chr, 
-            key_1L_chr = key_1L_chr, server_1L_chr = server_1L_chr)
+        object_type_lup <- get_rds_from_pkg_dmt(fl_nm_1L_chr = "object_type_lup", 
+            piggyback_to_1L_chr = dv_ds_nm_1L_chr)
     nchar_int <- nchar(object_type_lup$short_name_chr)
     match_chr <- object_type_lup$long_name_chr[endsWith(argument_nm_1L_chr, 
         paste0(ifelse(nchar(argument_nm_1L_chr) == nchar_int, 
@@ -386,26 +384,24 @@ get_new_fn_types <- function (pkg_setup_ls, fn_nms_ls = make_fn_nms(), undmtd_fn
 #' Get object type new cases
 #' @description get_obj_type_new_cses() is a Get function that retrieves a pre-existing data object from memory, local file system or online repository. Specifically, this function implements an algorithm to get object type new cases. Function argument updated_obj_type_lup specifies the where to look for the required object. The function returns Object type lookup table new cases (a tibble).
 #' @param updated_obj_type_lup Updated object type (a lookup table)
-#' @param dv_ds_nm_1L_chr Dataverse dataset name (a character vector of length one), Default: 'https://doi.org/10.7910/DVN/2Y9VF9'
-#' @param dv_url_pfx_1L_chr Dataverse url prefix (a character vector of length one), Default: character(0)
+#' @param dv_ds_nm_1L_chr Dataverse dataset name (a character vector of length one), Default: 'ready4-dev/ready4'
+#' @param dv_url_pfx_1L_chr Dataverse url prefix (a character vector of length one), Default: deprecated()
 #' @param excluded_chr Excluded (a character vector), Default: 'NA'
-#' @param key_1L_chr Key (a character vector of length one), Default: NULL
+#' @param key_1L_chr Key (a character vector of length one), Default: deprecated()
 #' @param old_obj_type_lup Old object type (a lookup table), Default: NULL
-#' @param server_1L_chr Server (a character vector of length one), Default: Sys.getenv("DATAVERSE_SERVER")
+#' @param server_1L_chr Server (a character vector of length one), Default: deprecated()
 #' @return Object type lookup table new cases (a tibble)
 #' @rdname get_obj_type_new_cses
 #' @export 
-#' @importFrom ready4 get_rds_from_dv
 #' @importFrom dplyr filter
 #' @keywords internal
-get_obj_type_new_cses <- function (updated_obj_type_lup, dv_ds_nm_1L_chr = "https://doi.org/10.7910/DVN/2Y9VF9", 
-    dv_url_pfx_1L_chr = character(0), excluded_chr = NA_character_, 
-    key_1L_chr = NULL, old_obj_type_lup = NULL, server_1L_chr = Sys.getenv("DATAVERSE_SERVER")) 
+get_obj_type_new_cses <- function (updated_obj_type_lup, dv_ds_nm_1L_chr = "ready4-dev/ready4", 
+    dv_url_pfx_1L_chr = deprecated(), excluded_chr = NA_character_, 
+    key_1L_chr = deprecated(), old_obj_type_lup = NULL, server_1L_chr = deprecated()) 
 {
     if (is.null(old_obj_type_lup)) 
-        old_obj_type_lup <- ready4::get_rds_from_dv("object_type_lup", 
-            dv_ds_nm_1L_chr = dv_ds_nm_1L_chr, dv_url_pfx_1L_chr = dv_url_pfx_1L_chr, 
-            key_1L_chr = key_1L_chr, server_1L_chr = server_1L_chr)
+        old_obj_type_lup <- get_rds_from_pkg_dmt(fl_nm_1L_chr = "object_type_lup", 
+            piggyback_to_1L_chr = dv_ds_nm_1L_chr)
     obj_type_lup_new_cses_tb <- updated_obj_type_lup %>% dplyr::filter(!short_name_chr %in% 
         old_obj_type_lup$short_name_chr)
     if (!is.na(excluded_chr[1])) 
@@ -417,27 +413,25 @@ get_obj_type_new_cses <- function (updated_obj_type_lup, dv_ds_nm_1L_chr = "http
 #' @description get_outp_obj_type() is a Get function that retrieves a pre-existing data object from memory, local file system or online repository. Specifically, this function implements an algorithm to get output object type. Function argument fns_chr specifies the where to look for the required object. The function returns Output object type (a character vector).
 #' @param fns_chr Functions (a character vector)
 #' @param abbreviations_lup Abbreviations (a lookup table)
-#' @param dv_ds_nm_1L_chr Dataverse dataset name (a character vector of length one), Default: 'https://doi.org/10.7910/DVN/2Y9VF9'
-#' @param dv_url_pfx_1L_chr Dataverse url prefix (a character vector of length one), Default: character(0)
+#' @param dv_ds_nm_1L_chr Dataverse dataset name (a character vector of length one), Default: 'ready4-dev/ready4'
+#' @param dv_url_pfx_1L_chr Dataverse url prefix (a character vector of length one), Default: deprecated()
 #' @param fns_env_ls Functions (a list of environments)
 #' @param is_generic_lgl Is generic (a logical vector), Default: F
-#' @param key_1L_chr Key (a character vector of length one), Default: NULL
+#' @param key_1L_chr Key (a character vector of length one), Default: deprecated()
 #' @param object_type_lup Object type (a lookup table), Default: NULL
-#' @param server_1L_chr Server (a character vector of length one), Default: Sys.getenv("DATAVERSE_SERVER")
+#' @param server_1L_chr Server (a character vector of length one), Default: deprecated()
 #' @return Output object type (a character vector)
 #' @rdname get_outp_obj_type
 #' @export 
-#' @importFrom ready4 get_rds_from_dv
 #' @importFrom purrr map2_chr
 #' @keywords internal
-get_outp_obj_type <- function (fns_chr, abbreviations_lup, dv_ds_nm_1L_chr = "https://doi.org/10.7910/DVN/2Y9VF9", 
-    dv_url_pfx_1L_chr = character(0), fns_env_ls, is_generic_lgl = F, 
-    key_1L_chr = NULL, object_type_lup = NULL, server_1L_chr = Sys.getenv("DATAVERSE_SERVER")) 
+get_outp_obj_type <- function (fns_chr, abbreviations_lup, dv_ds_nm_1L_chr = "ready4-dev/ready4", 
+    dv_url_pfx_1L_chr = deprecated(), fns_env_ls, is_generic_lgl = F, 
+    key_1L_chr = deprecated(), object_type_lup = NULL, server_1L_chr = deprecated()) 
 {
     if (is.null(object_type_lup)) 
-        object_type_lup <- ready4::get_rds_from_dv("object_type_lup", 
-            dv_ds_nm_1L_chr = dv_ds_nm_1L_chr, dv_url_pfx_1L_chr = dv_url_pfx_1L_chr, 
-            key_1L_chr = key_1L_chr, server_1L_chr = server_1L_chr)
+        object_type_lup <- get_rds_from_pkg_dmt(fl_nm_1L_chr = "object_type_lup", 
+            piggyback_to_1L_chr = dv_ds_nm_1L_chr)
     outp_obj_type_chr <- purrr::map2_chr(fns_chr, is_generic_lgl, 
         ~{
             if (.y) {
@@ -516,6 +510,30 @@ get_rds_from_dv <- function (file_nm_1L_chr, dv_ds_nm_1L_chr = "https://doi.org/
     }
     return(r_object_xx)
 }
+#' Get rds from package documentation
+#' @description get_rds_from_pkg_dmt() is a Get function that retrieves a pre-existing data object from memory, local file system or online repository. Specifically, this function implements an algorithm to get rds from package documentation. Function argument pkg_setup_ls specifies the where to look for the required object. The function returns R object (an output object of multiple potential types).
+#' @param pkg_setup_ls Package setup (a list), Default: NULL
+#' @param fl_nm_1L_chr File name (a character vector of length one)
+#' @param piggyback_to_1L_chr Piggyback to (a character vector of length one), Default: character(0)
+#' @param piggyback_tag_1L_chr Piggyback tag (a character vector of length one), Default: 'Documentation_0.0'
+#' @return R object (an output object of multiple potential types)
+#' @rdname get_rds_from_pkg_dmt
+#' @export 
+#' @importFrom piggyback pb_download_url
+#' @keywords internal
+get_rds_from_pkg_dmt <- function (pkg_setup_ls = NULL, fl_nm_1L_chr, piggyback_to_1L_chr = character(0), 
+    piggyback_tag_1L_chr = "Documentation_0.0") 
+{
+    if (!is.null(pkg_setup_ls)) {
+        piggyback_to_1L_chr <- pkg_setup_ls$subsequent_ls$piggyback_to_1L_chr
+    }
+    dmt_urls_chr <- piggyback::pb_download_url(repo = piggyback_to_1L_chr, 
+        tag = piggyback_tag_1L_chr)
+    dmt_url_1L_chr <- dmt_urls_chr[dmt_urls_chr %>% endsWith(paste0(fl_nm_1L_chr, 
+        ".Rds"))]
+    r_object_xx <- readRDS(url(dmt_url_1L_chr))
+    return(r_object_xx)
+}
 #' Get return object name
 #' @description get_return_obj_nm() is a Get function that retrieves a pre-existing data object from memory, local file system or online repository. Specifically, this function implements an algorithm to get return object name. Function argument fn specifies the where to look for the required object. The function returns Return (a character vector of length one).
 #' @param fn Function (a function)