From 3c8dad0170f66a51afb41f7da0a810689467ddae Mon Sep 17 00:00:00 2001 From: Ernest Guevarra Date: Thu, 6 Feb 2025 11:59:18 +0000 Subject: [PATCH 1/2] revert to v0.0.0.9000 --- DESCRIPTION | 6 +++--- man/riycf.Rd | 4 ++-- 2 files changed, 5 insertions(+), 5 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 5e93cb1..498b686 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -1,12 +1,12 @@ Package: riycf Type: Package Title: Utilities for Calculating Infant and Young Child Feeding Indicators -Version: 0.1.0.9000 +Version: 0.0.0.9000 Authors@R: c( person("Nicholus", "Tint Zaw", email = "nicholustintzaw@katilingban.io", - role = c("aut", "cre")), + role = c("aut", "cre", "cph")), person("Ernest", "Guevarra", comment = c(ORCID = "0000-0002-4887-4415"), - email = "ernest@guevarra.io", role = "aut"), + email = "ernest@guevarra.io", role = c("aut", "cph")), person("Rebecca", "Wolfe", role = "rev")) Description: This package aims to generate updated indicators to assess infant and young child feeding (IYCF) practices at the individual under 2 years old diff --git a/man/riycf.Rd b/man/riycf.Rd index 20d523d..0c21e97 100644 --- a/man/riycf.Rd +++ b/man/riycf.Rd @@ -38,11 +38,11 @@ Useful links: } \author{ -\strong{Maintainer}: Nicholus Tint Zaw \email{nicholustintzaw@katilingban.io} +\strong{Maintainer}: Nicholus Tint Zaw \email{nicholustintzaw@katilingban.io} [copyright holder] Authors: \itemize{ - \item Ernest Guevarra \email{ernest@guevarra.io} (\href{https://orcid.org/0000-0002-4887-4415}{ORCID}) + \item Ernest Guevarra \email{ernest@guevarra.io} (\href{https://orcid.org/0000-0002-4887-4415}{ORCID}) [copyright holder] } Other contributors: From 569f143a204e8b183a15c0b542b41c9ee5a6f0d2 Mon Sep 17 00:00:00 2001 From: Ernest Guevarra Date: Thu, 6 Feb 2025 13:46:05 +0000 Subject: [PATCH 2/2] update README; fix #39 --- NEWS.md | 1 - README.Rmd | 23 ++++++++++++++++++----- README.md | 52 ++++++++++++++++++++++++++++++++++++++++++++-------- 3 files changed, 62 insertions(+), 14 deletions(-) diff --git a/NEWS.md b/NEWS.md index 99a14e1..b3246d1 100644 --- a/NEWS.md +++ b/NEWS.md @@ -2,4 +2,3 @@ This is a pre-release of the `riycf` package. -* Added a `NEWS.md` file to track changes to the package. diff --git a/README.Rmd b/README.Rmd index c3446e7..88988c1 100644 --- a/README.Rmd +++ b/README.Rmd @@ -42,9 +42,13 @@ This riycf package aims to address that technical gap by providing an easy-to-us ## Installation +The `{riycf}` package is not yet available on [CRAN](https://cran.r-project.org) but can be installed via the [nutriverse R Universe](https://nutriverse.r-universe.dev): + ```{r, eval = FALSE} -if(!require(remotes)) install.packages("remotes") -remotes::install_github("nutriverse/riycf") +install.packages( + "riycf", + repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org') +) ``` @@ -55,12 +59,21 @@ Based on the WHO guideline’s indicator definition, the riycf package functions 2. *IYCF indicator generation*: The indicator calculation process would continue if there were no issues with the data entry. The new IYCF indicator variables will be generated based on which indicators the user asks to calculate. For example, suppose the user wanted to calculate whether the beneficiaries meet the minimum meal frequency. In this case, the user can use the `get_mmf` functions to create a new dichotomous variable that indicates whether each child met the minimum meal frequency. More sample codes from this package were present in each function documentation. -## Data Collection with CATI +## Data collection with computer-assisted personal interviews (CAPI) This package also provides the already programmed IYCF Questionnaires (based on WHO sample IYCF questionnaires) in XLS programming format. Detailed guidelines for accessing those forms are provided in the vignette article called "WHO IYCF Questionnaire XLS Forms." The different types of XLS programmed IYCF questionnaires can download on [this Github page](https://github.com/nicholustintzaw/iycf_xls_forms). +## Citation + +If you use `{riycf}` in your work, please cite using the suggested citation provided by a call to the `citation` function as follows: + +```{r cite} +citation("riycf") +``` + +## Community guidelines -## Code of Conduct +Feedback, bug reports, and feature requests are welcome; file issues or seek support [here](https://github.com/nutriverse/riycf/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://nutriverse.io/riycf/CONTRIBUTING.html). -Please note that the riycf project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. +This project is released with a [Contributor Code of Conduct](https://nutriverse.io/riycf/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms. diff --git a/README.md b/README.md index 1f652d5..f1c0d9f 100644 --- a/README.md +++ b/README.md @@ -65,9 +65,15 @@ to make it easier for those less familiar with R software. ## Installation +The `{riycf}` package is not yet available on +[CRAN](https://cran.r-project.org) but can be installed via the +[nutriverse R Universe](https://nutriverse.r-universe.dev): + ``` r -if(!require(remotes)) install.packages("remotes") -remotes::install_github("nutriverse/riycf") +install.packages( + "riycf", + repos = c('https://nutriverse.r-universe.dev', 'https://cloud.r-project.org') +) ``` ## How does the package work? @@ -98,7 +104,7 @@ will perform the following tasks. minimum meal frequency. More sample codes from this package were present in each function documentation. -## Data Collection with CATI +## Data collection with computer-assisted personal interviews (CAPI) This package also provides the already programmed IYCF Questionnaires (based on WHO sample IYCF questionnaires) in XLS programming format. @@ -107,9 +113,39 @@ vignette article called “WHO IYCF Questionnaire XLS Forms.” The different types of XLS programmed IYCF questionnaires can download on [this Github page](https://github.com/nicholustintzaw/iycf_xls_forms). -## Code of Conduct +## Citation + +If you use `{riycf}` in your work, please cite using the suggested +citation provided by a call to the `citation` function as follows: + +``` r +citation("riycf") +#> Warning in citation("riycf"): could not determine year for 'riycf' from package +#> DESCRIPTION file +#> To cite package 'riycf' in publications use: +#> +#> Tint Zaw N, Guevarra E (????). _riycf: Utilities for Calculating +#> Infant and Young Child Feeding Indicators_. R package version +#> 0.0.0.9000, https://github.com/nutriverse/riycf, +#> . +#> +#> A BibTeX entry for LaTeX users is +#> +#> @Manual{, +#> title = {riycf: Utilities for Calculating Infant and Young Child Feeding Indicators}, +#> author = {Nicholus {Tint Zaw} and Ernest Guevarra}, +#> note = {R package version 0.0.0.9000, https://github.com/nutriverse/riycf}, +#> url = {https://nutriverse.io/riycf/}, +#> } +``` + +## Community guidelines + +Feedback, bug reports, and feature requests are welcome; file issues or +seek support [here](https://github.com/nutriverse/riycf/issues). If you +would like to contribute to the package, please see our [contributing +guidelines](https://nutriverse.io/riycf/CONTRIBUTING.html). -Please note that the riycf project is released with a [Contributor Code -of -Conduct](https://contributor-covenant.org/version/2/0/CODE_OF_CONDUCT.html). -By contributing to this project, you agree to abide by its terms. +This project is released with a [Contributor Code of +Conduct](https://nutriverse.io/riycf/CODE_OF_CONDUCT.html). By +contributing to this project, you agree to abide by its terms.