Merge pull request #9 from nutriverse/dev

update website
nutriverse · Jan 6, 2023 · 043d6a4 · 043d6a4
2 parents 486caf9 + dbc9b54
commit 043d6a4
Show file tree

Hide file tree

Showing 33 changed files with 3,205 additions and 3,088 deletions.
diff --git a/.github/CONTRIBUTING.md b/.github/CONTRIBUTING.md
@@ -2,7 +2,7 @@
 
 ## Bugs
 
-* Submit an issue on the [issues page](https://github.com/nutriverse/squeacr/issues)
+* Submit an issue on the [issues page](https://github.com/nutriverse/sleacr/issues)
 
 ## Code contributions
 
@@ -11,14 +11,14 @@
 * Clone your version on your account down to your machine from your account
 
 ```
-git clone https://github.com/<yourgithubusername>/squeacr.git
+git clone https://github.com/<yourgithubusername>/sleacr.git
 ```
 
-* Make sure to track progress upstream i.e., on our version of `intergrowth`
-at `nutriverse/squeacr`, by doing
+* Make sure to track progress upstream i.e., on our version of `sleacr`
+at `nutriverse/sleacr`, by doing
 
 ```
-git remote add upstream https://github.com/nutriverse/squeacr.git
+git remote add upstream https://github.com/nutriverse/sleacr.git
 ```
 
 * Before making changes make sure to pull changes in from `upstream` by doing
@@ -32,4 +32,4 @@ documentation
 
 * Push up changes to your account
 
-* Submit a pull request at `nutriverse/squeacr`
+* Submit a pull request at `nutriverse/sleacr`
diff --git a/.gitignore b/.gitignore
@@ -4,3 +4,4 @@
 .Ruserdata
 .DS_Store
 docs
+inst/doc
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -5,28 +5,33 @@ Title: Simplified Lot Quality Assurance Sampling Evaluation of Access and
 Version: 0.0.0.9000
 Authors@R: person("Ernest", "Guevarra", 
     comment = c(ORCID = "0000-0002-4887-4415"), 
-    email = "[email protected]", role = c("aut", "cre", "cph"))
+    email = "[email protected]", role = c("aut", "cre"))
 Description: In the recent past, measurement of coverage has been mainly through 
     two-stage cluster sampled surveys either as part of a nutrition assessment 
     or through a specific coverage survey known as Centric Systematic Area 
     Sampling (CSAS). However, such methods are resource intensive and often only 
     used for final programme evaluation meaning results arrive too late for 
-    programme adaptation. SLEAC, which stands for Simplified Lot Quality Assurance 
-    Sampling Evaluation of Access and Coverage, is a low resource method designed 
-    specifically to address this limitation and is used regularly for monitoring, 
-    planning and importantly, timely improvement to programme quality, both for 
-    agency and Ministry of Health (MoH) led programmes. SLEAC is designed to
-    complement the Semi-quantitative Evaluation of Access and Coverage (SQUEAC)
-    method. This package provides functions for use in conducting a SLEAC 
-    assessment.
+    programme adaptation. SLEAC, which stands for Simplified Lot Quality 
+    Assurance Sampling Evaluation of Access and Coverage, is a low resource 
+    method designed specifically to address this limitation and is used 
+    regularly for monitoring, planning and importantly, timely improvement to 
+    programme quality, both for agency and Ministry of Health (MoH) led 
+    programmes. SLEAC is designed to complement the Semi-quantitative Evaluation 
+    of Access and Coverage (SQUEAC) method. This package provides functions for 
+    use in conducting a SLEAC assessment.
 License: GPL-3
 Suggests: 
     covr,
-    spelling
+    knitr,
+    rmarkdown,
+    spelling,
+    testthat (>= 3.0.0)
 Encoding: UTF-8
 Language: en-GB
 LazyData: true
 RoxygenNote: 7.2.3
 Roxygen: list(markdown = TRUE)
 URL: https://nutriverse.io/sleacr/, https://github.com/nutriverse/sleacr
 BugReports: https://github.com/nutriverse/sleacr/issues
+Config/testthat/edition: 3
+VignetteBuilder: knitr
diff --git a/README.Rmd b/README.Rmd
@@ -19,6 +19,7 @@ knitr::opts_chunk$set(
 [![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
 [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 [![R-CMD-check](https://github.com/nutriverse/sleacr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nutriverse/sleacr/actions/workflows/R-CMD-check.yaml)
+[![test-coverage](https://github.com/nutriverse/sleacr/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/nutriverse/sleacr/actions/workflows/test-coverage.yaml)
 [![Codecov test coverage](https://codecov.io/gh/nutriverse/sleacr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/nutriverse/sleacr?branch=main)
 [![CodeFactor](https://www.codefactor.io/repository/github/nutriverse/sleacr/badge)](https://www.codefactor.io/repository/github/nutriverse/sleacr)
 <!-- badges: end -->

diff --git a/README.md b/README.md
@@ -11,6 +11,7 @@ public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostat
 [![Lifecycle:
 experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://www.tidyverse.org/lifecycle/#experimental)
 [![R-CMD-check](https://github.com/nutriverse/sleacr/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/nutriverse/sleacr/actions/workflows/R-CMD-check.yaml)
+[![test-coverage](https://github.com/nutriverse/sleacr/actions/workflows/test-coverage.yaml/badge.svg)](https://github.com/nutriverse/sleacr/actions/workflows/test-coverage.yaml)
 [![Codecov test
 coverage](https://codecov.io/gh/nutriverse/sleacr/branch/main/graph/badge.svg)](https://app.codecov.io/gh/nutriverse/sleacr?branch=main)
 [![CodeFactor](https://www.codefactor.io/repository/github/nutriverse/sleacr/badge)](https://www.codefactor.io/repository/github/nutriverse/sleacr)

diff --git a/docs/404.html b/docs/404.html
diff --git a/docs/authors.html b/docs/authors.html
diff --git a/docs/index.html b/docs/index.html
diff --git a/docs/news/index.html b/docs/news/index.html
diff --git a/docs/pkgdown.yml b/docs/pkgdown.yml
@@ -1,8 +1,9 @@
 pandoc: 2.19.2
 pkgdown: 2.0.7
 pkgdown_sha: ~
-articles: {}
-last_built: 2023-01-06T17:44Z
+articles:
+  sleacr: sleacr.html
+last_built: 2023-01-06T22:07Z
 urls:
   reference: https://nutriverse.io/sleacr/reference
   article: https://nutriverse.io/sleacr/articles

diff --git a/docs/reference/get_binom_hypergeom.html b/docs/reference/get_binom_hypergeom.html
diff --git a/docs/reference/get_class_prob.html b/docs/reference/get_class_prob.html
diff --git a/docs/reference/get_d.html b/docs/reference/get_d.html
diff --git a/docs/reference/get_hypergeom.html b/docs/reference/get_hypergeom.html
diff --git a/docs/reference/get_hypergeom_cumulative.html b/docs/reference/get_hypergeom_cumulative.html
diff --git a/docs/reference/get_n.html b/docs/reference/get_n.html
diff --git a/docs/reference/get_n_cases.html b/docs/reference/get_n_cases.html
diff --git a/docs/reference/get_n_clusters.html b/docs/reference/get_n_clusters.html
diff --git a/docs/reference/index.html b/docs/reference/index.html
diff --git a/docs/reference/make_data.html b/docs/reference/make_data.html
diff --git a/docs/reference/plot.lqasSim-1.png b/docs/reference/plot.lqasSim-1.png
diff --git a/docs/reference/plot.lqasSim.html b/docs/reference/plot.lqasSim.html