Skip to content

Commit

Permalink
attempt at ensuring text for no value tag
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewphamilton committed Dec 1, 2023
1 parent 051a283 commit 9d41db8
Show file tree
Hide file tree
Showing 53 changed files with 178 additions and 50 deletions.
6 changes: 3 additions & 3 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -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.9534. Zenodo. https://doi.org/10.5281/zenodo.5611779"
Economic Model Algorithms. Version 0.0.0.9535. 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]"
- 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.9534
version: 0.0.0.9535
doi: 10.5281/zenodo.5611779
date-released: 2023-11-18
date-released: 2023-12-02
url: "https://ready4-dev.github.io/ready4fun/"
1 change: 1 addition & 0 deletions NAMESPACE
Original file line number Diff line number Diff line change
Expand Up @@ -252,6 +252,7 @@ importFrom(ready4,transform_cls_type_ls)
importFrom(ready4,update_pt_fn_args_ls)
importFrom(ready4,update_tb_r3)
importFrom(ready4,write_citation_cff)
importFrom(ready4,write_conditional_tags)
importFrom(ready4,write_env_objs_to_dv)
importFrom(ready4,write_examples)
importFrom(ready4,write_extra_pkgs_to_actions)
Expand Down
4 changes: 2 additions & 2 deletions R/fn_add.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Add additional packages
#' @description add_addl_pkgs() is an Add function that updates an object by adding new values to new or empty fields. Specifically, this function implements an algorithm to add additional packages. The function is called for its side effects and does not return a value.
#' @param addl_pkgs_ls Additional packages (a list)
#' @return NULL
#' @return No return value, called for side effects.
#' @rdname add_addl_pkgs
#' @export
#' @importFrom purrr walk2 walk
Expand All @@ -21,7 +21,7 @@ add_addl_pkgs <- function (addl_pkgs_ls)
#' Add build ignore
#' @description add_build_ignore() is an Add function that updates an object by adding new values to new or empty fields. Specifically, this function implements an algorithm to add build ignore. The function is called for its side effects and does not return a value.
#' @param build_ignore_ls Build ignore (a list)
#' @return NULL
#' @return No return value, called for side effects.
#' @rdname add_build_ignore
#' @export
#' @importFrom purrr walk
Expand Down
2 changes: 1 addition & 1 deletion R/fn_assert.R
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@
#' @description assert_inp_does_not_match_terms() is an Assert function that validates that an object conforms to required condition(s). If the object does not meet all required conditions, program execution will be stopped and an error message provided. Specifically, this function implements an algorithm to assert input does not match terms. The function is called for its side effects and does not return a value.
#' @param input_chr Input (a character vector)
#' @param exclude_if_match_chr Exclude if match (a character vector)
#' @return NULL
#' @return No return value, called for side effects.
#' @rdname assert_inp_does_not_match_terms
#' @export
#' @importFrom testit assert
Expand Down
2 changes: 1 addition & 1 deletion R/fn_close.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Close open sinks
#' @description close_open_sinks() is a Close function that closes specified connections. Specifically, this function implements an algorithm to close open sinks. The function is called for its side effects and does not return a value.

#' @return NULL
#' @return No return value, called for side effects.
#' @rdname close_open_sinks
#' @export
#' @importFrom purrr walk
Expand Down
2 changes: 1 addition & 1 deletion R/fn_force.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Force install of required package
#' @description force_instl_of_reqd_pkg() is a Force function that checks if a specified local or global environmental condition is met and if not, updates the specified environment to comply with the condition. Specifically, this function implements an algorithm to force install of required package. The function is called for its side effects and does not return a value.
#' @param package_nm_1L_chr Package name (a character vector of length one)
#' @return NULL
#' @return No return value, called for side effects.
#' @rdname force_instl_of_reqd_pkg
#' @export
#' @importFrom utils installed.packages install.packages
Expand Down
2 changes: 1 addition & 1 deletion R/fn_make.R
Original file line number Diff line number Diff line change
Expand Up @@ -877,7 +877,7 @@ make_gtr_str_dmt_spine <- function (fn_type_1L_chr, fn_name_1L_chr, class_name_1
#' @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: deprecated()
#' @return NULL
#' @return No return value, called for side effects.
#' @rdname make_lines_for_fn_dmt
#' @export
#' @keywords internal
Expand Down
2 changes: 1 addition & 1 deletion R/fn_unload.R
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
#' Unload packages
#' @description unload_packages() is an Unload function that performs a custom detaching of a package from the search path. Specifically, this function implements an algorithm to unload packages. The function is called for its side effects and does not return a value.
#' @param package_chr Package (a character vector)
#' @return NULL
#' @return No return value, called for side effects.
#' @rdname unload_packages
#' @export
#' @importFrom purrr discard map_lgl walk
Expand Down
4 changes: 3 additions & 1 deletion R/fn_update.R
Original file line number Diff line number Diff line change
Expand Up @@ -117,7 +117,9 @@ update_fn_dmt <- function (fn_tags_spine_ls, new_tag_chr_ls, fn_name_1L_chr, fn_
ifelse((fn_type_1L_chr %in% c("fn", "gen_std_s3_mthd",
"meth_std_s3_mthd", "gen_std_s4_mthd", "meth_std_s4_mthd") |
startsWith(fn_type_1L_chr, "s3_")), "", fn_tags_spine_ls$ref_slot_1L_chr))) %>%
stringr::str_replace("OUTPUT_DESCRIPTION", new_tag_chr_ls$output_txt_1L_chr)
stringr::str_replace("OUTPUT_DESCRIPTION", ifelse(new_tag_chr_ls$output_txt_1L_chr ==
"NULL", "No return value, called for side effects.",
new_tag_chr_ls$output_txt_1L_chr))
fn_dmt_1L_chr <- fn_dmt_1L_chr %>% stringr::str_replace("@details DETAILS",
ifelse(fn_type_1L_chr == "s3_valid_instance" | ifelse(is.na(new_tag_chr_ls$fn_det_1L_chr),
F, ifelse(fn_type_1L_chr %in% c("s3_prototype", "s3_checker"),
Expand Down
Loading

0 comments on commit 9d41db8

Please sign in to comment.