Skip to content

Commit

Permalink
DESCRIPTION edits
Browse files Browse the repository at this point in the history
  • Loading branch information
matthewphamilton committed Nov 11, 2023
1 parent a4756e2 commit 927b703
Show file tree
Hide file tree
Showing 6 changed files with 56 additions and 58 deletions.
4 changes: 2 additions & 2 deletions CITATION.cff
Original file line number Diff line number Diff line change
@@ -1,12 +1,12 @@
cff-version: 1.2.0
message: "Matthew P Hamilton (2023). ready4: Implement Transparent, Reusable and Updatable Computational Health
Economic Models. Version 0.0.0.9127. Zenodo. https://doi.org/10.5281/zenodo.5606250"
Economic Models. Version 0.0.0.9128. Zenodo. https://doi.org/10.5281/zenodo.5606250"
authors:
- family-names: "Hamilton"
given-names: "Matthew P"
title: "ready4: Implement Transparent, Reusable and Updatable Computational Health
Economic Models"
version: 0.0.0.9127
version: 0.0.0.9128
doi: 10.5281/zenodo.5606250
date-released: 2023-11-11
url: "https://ready4-dev.github.io/ready4/"
15 changes: 3 additions & 12 deletions DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,6 @@ Collate:
'C4_Ready4Module.R'
'C4_Ready4Private.R'
'C4_Ready4Public.R'
'add.R'
'bind.R'
'fn_add.R'
'fn_bind.R'
'fn_get.R'
Expand All @@ -43,11 +41,9 @@ Collate:
'fn_transform.R'
'fn_update.R'
'fn_write.R'
'get.R'
'grp_generics.R'
'imp_fns.R'
'imp_mthds.R'
'make.R'
'mthd_authorSlot.R'
'mthd_characterizeSlot.R'
'mthd_depictSlot.R'
Expand All @@ -64,13 +60,7 @@ Collate:
'mthd_renewSlot.R'
'mthd_shareSlot.R'
'pkg_ready4.R'
'print.R'
'ready4-package.R'
'remove.R'
'rowbind.R'
'transform.R'
'update.R'
'write.R'
Imports:
assertthat,
bib2df,
Expand All @@ -79,7 +69,6 @@ Imports:
fs,
Hmisc,
kableExtra,
knitr,
lifecycle,
magrittr,
methods,
Expand All @@ -95,11 +84,13 @@ Imports:
stringi,
stringr,
testit,
testthat,
tibble,
tidyRSS,
tidyselect,
tools,
utils,
zen4R
VignetteBuilder: knitr
Suggests:
knitr,
testthat
17 changes: 11 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,12 +11,17 @@
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.5606250.svg)](https://doi.org/10.5281/zenodo.5606250)
<!-- badges: end -->

Foundational elements (classes, generics, methods, functions)
of a prototype software framework for developing modular, open source
computational health economic models. The foundation provided by
'ready4' is extended by other R packages. For detailed documentation
visit <https://www.ready4-dev.com/>. For a scientific summary read
<arxiv:2310.14138>.
A prototype software framework to support ethical
implementation of health economic models. To help health economists
adopt a modular and collaborative approach to model development
'ready4' provides a template model module, a simple programming syntax
and tools for finding and documenting model modules. These
foundational elements of the 'ready4' software framework are extended
by other R packages. For detailed documentation about how to use
'ready4' and its extensions visit <https://www.ready4-dev.com/>. For
a scientific summary of the rationale for transparent, reusable And
updatable computational health economic models read
<arXiv:2310.14138>.

To install a development version of this software, run the following commands in your R console:

Expand Down
36 changes: 1 addition & 35 deletions data-raw/CRAN_PREP.R
Original file line number Diff line number Diff line change
Expand Up @@ -5,41 +5,7 @@
# install.packages('attachment', repos = 'https://thinkr-open.r-universe.dev')
# attachment::att_amend_desc()
#unlink("dev",T)
citation_chr <- readLines("inst/CITATION")
citation_chr[3] <- stringr::str_replace(citation_chr[3], "citEntry", "bibentry")
citation_chr[4] <- stringr::str_replace(citation_chr[4], "entry", "bibtype")
citation_chr[8] <- stringr::str_replace(citation_chr[8], "2021", "2023")
citation_chr[12] <- stringr::str_replace(citation_chr[12], "2021", "2023")
citation_chr %>%
writeLines(con = "inst/CITATION")
readLines("README.md") %>%
stringr::str_replace_all("svg\\)]\\(https://codecov.io","svg\\)]\\(https://app.codecov.io") %>%
writeLines(con = "README.md")
c(readLines("R/imp_fns.R"),
" ",
"#' NSE equals function",
"#'",
"#' Import of non standard evaluation equals function for use in dplyr calls.",
"#'",
"#' @importFrom rlang :=",
"#' @name :=",
"#' @rdname nseequals",
"#' @export",
"#' @keywords internal",
"NULL",
" ",
"#' Dot Data function",
"#'",
"#' Import of .data function for use in dataset manipulation within functions.",
"#'",
"#' @importFrom rlang .data",
"#' @name .data",
"#' @rdname dotdata",
"#' @export",
"#' @keywords internal",
"NULL"
) %>%
writeLines("R/imp_fns.R")

# Run tests and examples
devtools::test()
devtools::run_examples()
Expand Down
38 changes: 37 additions & 1 deletion data-raw/DATASET.R
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ source("data-raw/FUNCTIONS.R") # Required to manage conflicts
x <- ready4fun::make_pkg_desc_ls(pkg_title_1L_chr = "Implement Transparent, Reusable And Updatable Computational Health Economic Models" %>% tools::toTitleCase(),
pkg_desc_1L_chr = "A prototype software framework to support ethical implementation of health economic models. To help health economists adopt a modular and collaborative approach to model development 'ready4' provides a template model module, a simple programming syntax and tools for finding and documenting model modules.
These foundational elements of the 'ready4' software framework are extended by other R packages. For detailed documentation about how to use 'ready4' and its extensions visit <https://www.ready4-dev.com/>.
For a scientific summary of the rationale for transparent, reusable And updatable computational health economic models read <arxiv:2310.14138>.",
For a scientific summary of the rationale for transparent, reusable And updatable computational health economic models read <arXiv:2310.14138>.",
authors_prsn = c(utils::person(
given = "Matthew",family = "Hamilton", email =
"matthew.hamilton1@monash.edu",role = c("aut",
Expand Down Expand Up @@ -68,6 +68,42 @@ readLines("DESCRIPTION")[-which(readLines("DESCRIPTION") %in% c(" knitr,", "
devtools::document()
usethis::use_package("knitr", type = "Suggests") # instead of imports
usethis::use_package("testthat", type = "Suggests")
citation_chr <- readLines("inst/CITATION")
citation_chr[3] <- stringr::str_replace(citation_chr[3], "citEntry", "bibentry")
citation_chr[4] <- stringr::str_replace(citation_chr[4], "entry", "bibtype")
citation_chr[8] <- stringr::str_replace(citation_chr[8], "2021", "2023")
citation_chr[12] <- stringr::str_replace(citation_chr[12], "2021", "2023")
citation_chr %>%
writeLines(con = "inst/CITATION")
readLines("README.md") %>%
stringr::str_replace_all("svg\\)]\\(https://codecov.io","svg\\)]\\(https://app.codecov.io") %>%
writeLines(con = "README.md")
c(readLines("R/imp_fns.R"),
" ",
"#' NSE equals function",
"#'",
"#' Import of non standard evaluation equals function for use in dplyr calls.",
"#'",
"#' @importFrom rlang :=",
"#' @name :=",
"#' @rdname nseequals",
"#' @export",
"#' @keywords internal",
"NULL",
" ",
"#' Dot Data function",
"#'",
"#' Import of .data function for use in dataset manipulation within functions.",
"#'",
"#' @importFrom rlang .data",
"#' @name .data",
"#' @rdname dotdata",
"#' @export",
"#' @keywords internal",
"NULL"
) %>%
writeLines("R/imp_fns.R")
devtools::document()
devtools::build_vignettes()
#
# ADD DOI OVERRIDE FOR RELEASES
Expand Down
4 changes: 2 additions & 2 deletions man/ready4-package.Rd

Some generated files are not rendered by default. Learn more about how customized files appear on GitHub.

0 comments on commit 927b703

Please sign in to comment.