updated import fns

.github/workflows/pkgdown.yaml

@@ -22,7 +22,7 @@ jobs:
     permissions:
       contents: write
     steps:
-      - uses: actions/checkout@v3
+      - uses: actions/checkout@v4
 
       - uses: r-lib/actions/setup-tinytex@v2
 
@@ -51,7 +51,7 @@ jobs:
 
       - name: Deploy to GitHub pages 🚀
         if: github.event_name != 'pull_request'
-        uses: JamesIves/github-pages-deploy-action@v4.4.1
+        uses: JamesIves/github-pages-deploy-action@v4.5.0
         with:
           clean: false
           branch: gh-pages

CITATION.cff

@@ -1,14 +1,14 @@
 cff-version: 1.2.0
-message: "Matthew Hamilton <[email protected]> [aut, cre] (<https://orcid.org/0000-0001-7407-9194>) and Glen Wiesner [aut] (<https://orcid.org/0000-0002-0071-130X>)  (2023). ready4fun: Author and Document Functions that Implement Transferable Health
-Economic Model Algorithms. Version 0.0.0.9535. Zenodo. https://doi.org/10.5281/zenodo.5611779"
+message: "Matthew Hamilton <[email protected]> [aut, cre, cph] (<https://orcid.org/0000-0001-7407-9194>) and Glen Wiesner [aut] (<https://orcid.org/0000-0002-0071-130X>)  (2024). ready4fun: Author and Document Functions that Implement Transferable Health
+Economic Model Algorithms. Version 0.0.0.9537. Zenodo. https://doi.org/10.5281/zenodo.5611779"
 authors:
   - family-names: "(<https://orcid.org/0000-0001-7407-9194>)"
-    given-names: "Matthew Hamilton <[email protected]> [aut, cre]"
+    given-names: "Matthew Hamilton <[email protected]> [aut, cre, cph]"
   - family-names: "(<https://orcid.org/0000-0002-0071-130X>)"
     given-names: "Glen Wiesner [aut]"
 title: "ready4fun: Author and Document Functions that Implement Transferable Health
 Economic Model Algorithms"
-version: 0.0.0.9535
+version: 0.0.0.9537
 doi: 10.5281/zenodo.5611779
-date-released: 2023-12-02
+date-released: 2024-04-10
 url: "https://ready4-dev.github.io/ready4fun/"

LICENSE

@@ -1,6 +1,6 @@
 ready4fun - Author and Document Functions that Implement Transferable Health
     Economic Model Algorithms
-Copyright (C) 2023  Orygen
+Copyright (C) 2024  Matthew Hamilton and Orygen
 
 This program is free software: you can redistribute it and/or modify
 it under the terms of the GNU General Public License as published by

NAMESPACE

@@ -1,6 +1,8 @@
 # Generated by roxygen2: do not edit by hand
 
 export("%>%")
+export(":=")
+export(.data)
 export(add_addl_pkgs)
 export(add_build_ignore)
 export(add_fns_dmt_tb)
@@ -266,6 +268,8 @@ importFrom(ready4,write_to_edit_workflow)
 importFrom(ready4,write_to_publish_dv_ds)
 importFrom(ready4show,print_from_chunk)
 importFrom(ready4use,Ready4useRepos)
+importFrom(rlang,":=")
+importFrom(rlang,.data)
 importFrom(rlang,exec)
 importFrom(rlang,sym)
 importFrom(sinew,makeOxyFile)

R/fn_write.R

@@ -880,7 +880,7 @@ write_links_for_website <- function (path_to_pkg_rt_1L_chr = getwd(), pkg_url_1L
                   "  - text: Manual - Developer (PDF)", NA_character_), 
                 ifelse(!is.na(developer_manual_url_1L_chr), paste0("    href: ", 
                   developer_manual_url_1L_chr), NA_character_), 
-                ifelse(!is.na(project_website_url_1L_chr), "  - text: Framework and Model", 
+                ifelse(!is.na(project_website_url_1L_chr), "  - text: Model", 
                   NA_character_), ifelse(!is.na(project_website_url_1L_chr), 
                   paste0("    href: ", project_website_url_1L_chr), 
                   NA_character_), txt_chr) %>% stats::na.omit()

R/imp_fns.R

@@ -1,23 +1,47 @@
 #' Pipe operator
 #'
-#' Implements: https://github.com/sckott/analogsea/issues/32
-#' and https://github.com/rstudio/ggvis/blob/master/R/pipe.R.
+#' Import of [magrittr::%>%()]. See magrittr package documentation for detailed description.
 #'
 #' @importFrom magrittr %>%
 #' @name %>%
 #' @rdname pipe
 #' @export
-#' @param lhs,rhs An object and a function to apply to it
 #' @keywords internal
+#' @seealso [magrittr::%>%()]
 NULL
 
 #' Deprecated function
 #'
-#' Import of deprecated function as recommended in lifecycle package documentation.
+#' Import of [lifecycle::deprecated()]. See lifecycle package documentation for detailed description.
 #'
 #' @importFrom lifecycle deprecated
 #' @name deprecated
 #' @rdname deprecated
 #' @export
 #' @keywords internal
+#' @seealso [lifecycle::deprecated()]
+NULL
+
+#' Non standard evaluation assignment function
+#'
+#' Import of := function, implementing [rlang::dyn-dots()]. See rlang package documentation for detailed description.
+#'
+#' @importFrom rlang :=
+#' @name :=
+#' @rdname nseequals
+#' @export
+#' @keywords internal
+#' @seealso [rlang::dyn-dots()]
+NULL
+
+#' Dot Data function
+#'
+#' Import of [rlang::.data()]. See rlang package documentation for detailed description.
+#'
+#' @importFrom rlang .data
+#' @name .data
+#' @rdname dotdata
+#' @export
+#' @keywords internal
+#' @seealso [rlang::.data()]
 NULL

R/mthd_ratify.R

@@ -1,4 +1,4 @@
-#' Ratify that a dataset meets validity criteria
+#' Ratify that input or output data meet validity criteria
 #' @description ratify.ready4fun_manifest() is a ratify method that ratifies that an instance of a class conforms to specified criteria. This method is implemented for the ready4 submodule class for encapsulating the metadata required for package set-up. The function is called for its side effects and does not return a value.
 #' @param x An instance of `ready4fun_manifest`, a ready4 submodule class for encapsulating the metadata required for package set-up.
 #' @param append_1L_lgl Append (a logical vector of length one), Default: F

R/mthd_renew.R

@@ -1,4 +1,4 @@
-#' Renew values in a dataset
+#' Renew (update) values
 #' @description renew.ready4fun_abbreviations() is a renew method that renews an instance of a class by updating it with new data. This method is implemented for the ready4 submodule class for tibble object lookup table of abbreviations. The function is called for its side effects and does not return a value.
 #' @param x An instance of `ready4fun_abbreviations`, a ready4 submodule class for tibble object lookup table of abbreviations.
 #' @param short_name_chr Short name (a character vector), Default: 'NA'
@@ -32,7 +32,7 @@ renew.ready4fun_abbreviations <- function (x, short_name_chr = NA_character_, lo
 #' @aliases renew,ready4fun_abbreviations-method
 #' @importFrom ready4 renew
 methods::setMethod("renew", methods::className("ready4fun_abbreviations", package = "ready4fun"), renew.ready4fun_abbreviations)
-#' Renew values in a dataset
+#' Renew (update) values
 #' @description renew.ready4fun_functions() is a renew method that renews an instance of a class by updating it with new data. This method is implemented for the Function types lookup table. The function is called for its side effects and does not return a value.
 #' @param x An instance of `ready4fun_functions`, a Function types lookup table.
 #' @param fn_type_nm_chr Function type name (a character vector), Default: 'NA'
@@ -71,7 +71,7 @@ renew.ready4fun_functions <- function (x, fn_type_nm_chr = NA_character_, fn_typ
 #' @aliases renew,ready4fun_functions-method
 #' @importFrom ready4 renew
 methods::setMethod("renew", methods::className("ready4fun_functions", package = "ready4fun"), renew.ready4fun_functions)
-#' Renew values in a dataset
+#' Renew (update) values
 #' @description renew.ready4fun_manifest() is a renew method that renews an instance of a class by updating it with new data. This method is implemented for the ready4 submodule class for encapsulating the metadata required for package set-up. The function is called for its side effects and does not return a value.
 #' @param x An instance of `ready4fun_manifest`, a ready4 submodule class for encapsulating the metadata required for package set-up.
 #' @param type_1L_chr Type (a character vector of length one)
@@ -135,7 +135,7 @@ renew.ready4fun_manifest <- function (x, type_1L_chr, append_1L_lgl = F, are_wor
 #' @aliases renew,ready4fun_manifest-method
 #' @importFrom ready4 renew
 methods::setMethod("renew", methods::className("ready4fun_manifest", package = "ready4fun"), renew.ready4fun_manifest)
-#' Renew values in a dataset
+#' Renew (update) values
 #' @description renew.ready4fun_objects() is a renew method that renews an instance of a class by updating it with new data. This method is implemented for the Object types lookup table. The function is called for its side effects and does not return a value.
 #' @param x An instance of `ready4fun_objects`, a Object types lookup table.
 #' @param short_name_chr Short name (a character vector), Default: 'NA'

_pkgdown.yml

@@ -10,7 +10,7 @@ home:
     href: https://github.com/ready4-dev/ready4fun/releases/download/Documentation_0.0/ready4fun_User.pdf
   - text: Manual - Developer (PDF)
     href: https://github.com/ready4-dev/ready4fun/releases/download/Documentation_0.0/ready4fun_Developer.pdf
-  - text: Framework and Model
+  - text: Framework
     href:  https://www.ready4-dev.com/
 development:
   mode: auto

data-raw/DATASET.R

@@ -44,7 +44,7 @@ pkg_desc_ls <- fns_env_ls$fns_env$make_pkg_desc_ls(
     utils::person(
       given = "Matthew", family = "Hamilton",
       email = "[email protected]",
-      role = c("aut", "cre"),
+      role = c("aut", "cre", "cph"),
       comment = c(ORCID = "0000-0001-7407-9194")
     ),
     utils::person("Glen", "Wiesner",
@@ -271,7 +271,7 @@ manifest_ls <- pkg_desc_ls %>%
                                                                          get_fn_types = "All functions authored with the `ready4` framework need to begin with a verb. The definitions of all meaningful verbs used in functions authored for a ready4 framework model implementation can be retrieved using `get_fn_types()`.",
                                                                          get_obj_types ="The type of input (arguments) required and output (return) produced by a function can be efficiently communicated by using meaningful suffices. Definitions of all meaningful suffices used in functions authored for a ready4 framework model implementation can be retrieved using `get_obj_types()`."),
                                                           user_manual_fns_chr = c("get_abbrs", "get_fn_types", "get_obj_types")),
-    copyright_holders_chr = "Orygen",
+    copyright_holders_chr = "Matthew Hamilton and Orygen",
     dev_pkgs_chr = c("ready4", "ready4use", "ready4show"),
     inc_pkg_meta_data_1L_lgl = T, ###
     lifecycle_stage_1L_chr = "experimental",
@@ -286,3 +286,5 @@ manifest_ls <- fns_env_ls$fns_env$write_package(manifest_ls, self_serve_1L_lgl =
 usethis::use_dev_package("ready4show", remote = "ready4-dev/ready4show")
 devtools::build_vignettes()
 # fns_env_ls$fns_env$read_fns(fns_dir_1L_chr,use_env_1L_lgl = F)
+readLines("_pkgdown.yml") %>% stringr::str_replace("  - text: Model","  - text: Framework") %>%
+  writeLines("_pkgdown.yml")

data-raw/fns/write.R

@@ -973,7 +973,7 @@ write_links_for_website <- function(path_to_pkg_rt_1L_chr = getwd(),
         ifelse(!is.na(user_manual_url_1L_chr), paste0("    href: ", user_manual_url_1L_chr), NA_character_),
         ifelse(!is.na(developer_manual_url_1L_chr), "  - text: Manual - Developer (PDF)", NA_character_),
         ifelse(!is.na(developer_manual_url_1L_chr), paste0("    href: ", developer_manual_url_1L_chr), NA_character_),
-        ifelse(!is.na(project_website_url_1L_chr), "  - text: Framework and Model", NA_character_),
+        ifelse(!is.na(project_website_url_1L_chr), "  - text: Model", NA_character_),
         ifelse(!is.na(project_website_url_1L_chr), paste0("    href: ", project_website_url_1L_chr), NA_character_),
         txt_chr
       ) %>% stats::na.omit()

inst/CITATION

@@ -4,12 +4,12 @@ bibentry(
   bibtype  = "Manual",
   doi      = "10.5281/zenodo.5611779",
   title    = paste0(meta$Package,": ",meta$Title),
-  author   = c(person("Matthew Hamilton <[email protected]> [aut, cre]", "(<https://orcid.org/0000-0001-7407-9194>)"), person("Glen Wiesner [aut]", "(<https://orcid.org/0000-0002-0071-130X>)")),
-  year     = "2023",
+  author   = c(person("Matthew Hamilton <[email protected]> [aut, cre, cph]", "(<https://orcid.org/0000-0001-7407-9194>)"), person("Glen Wiesner [aut]", "(<https://orcid.org/0000-0002-0071-130X>)")),
+  year     = "2024",
   note     = sprintf("R package version %s", meta$Version),
   url      = "https://ready4-dev.github.io/ready4fun/",
-  textVersion = paste("Matthew Hamilton <[email protected]> [aut, cre] (<https://orcid.org/0000-0001-7407-9194>) and Glen Wiesner [aut] (<https://orcid.org/0000-0002-0071-130X>) ",
-  "(2023).",
+  textVersion = paste("Matthew Hamilton <[email protected]> [aut, cre, cph] (<https://orcid.org/0000-0001-7407-9194>) and Glen Wiesner [aut] (<https://orcid.org/0000-0002-0071-130X>) ",
+  "(2024).",
   paste0(meta$Package,": ",meta$Title,
   "."),
   paste0(sprintf("Version %s", meta$Version),"."),

inst/imp_fns_tmp.R

@@ -1,23 +1,47 @@
 #' Pipe operator
 #'
-#' Implements: https://github.com/sckott/analogsea/issues/32
-#' and https://github.com/rstudio/ggvis/blob/master/R/pipe.R.
+#' Import of [magrittr::%>%()]. See magrittr package documentation for detailed description.
 #'
 #' @importFrom magrittr %>%
 #' @name %>%
 #' @rdname pipe
 #' @export
-#' @param lhs,rhs An object and a function to apply to it
 #' @keywords internal
+#' @seealso [magrittr::%>%()]
 NULL
 
 #' Deprecated function
 #'
-#' Import of deprecated function as recommended in lifecycle package documentation.
+#' Import of [lifecycle::deprecated()]. See lifecycle package documentation for detailed description.
 #'
 #' @importFrom lifecycle deprecated
 #' @name deprecated
 #' @rdname deprecated
 #' @export
 #' @keywords internal
+#' @seealso [lifecycle::deprecated()]
+NULL
+
+#' Non standard evaluation assignment function
+#'
+#' Import of := function, implementing [rlang::dyn-dots()]. See rlang package documentation for detailed description.
+#'
+#' @importFrom rlang :=
+#' @name :=
+#' @rdname nseequals
+#' @export
+#' @keywords internal
+#' @seealso [rlang::dyn-dots()]
+NULL
+
+#' Dot Data function
+#'
+#' Import of [rlang::.data()]. See rlang package documentation for detailed description.
+#'
+#' @importFrom rlang .data
+#' @name .data
+#' @rdname dotdata
+#' @export
+#' @keywords internal
+#' @seealso [rlang::.data()]
 NULL