Merge pull request #42 from nutriverse:dev

fix readme

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 = "[email protected]",
-           role = c("aut", "cre")),
+           role = c("aut", "cre", "cph")),
     person("Ernest", "Guevarra", comment = c(ORCID = "0000-0002-4887-4415"), 
-           email = "[email protected]", role = "aut"), 
+           email = "[email protected]", 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

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.

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.
 

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,
+#>   <https://nutriverse.io/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.