Skip to content

Commit

Permalink
edit pkgdown.yml; fix #30; fix #31
Browse files Browse the repository at this point in the history
  • Loading branch information
ernestguevarra committed Oct 29, 2024
1 parent c5a55c0 commit 2cb2af9
Show file tree
Hide file tree
Showing 6 changed files with 54 additions and 57 deletions.
1 change: 1 addition & 0 deletions .Rbuildignore
Original file line number Diff line number Diff line change
Expand Up @@ -11,3 +11,4 @@
^pkgdown/_pkgdown\.yml$
^pkgdown$
^codecov\.yml$
^README\.html$
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -5,3 +5,5 @@
.DS_Store
inst/doc
docs

README.html
2 changes: 1 addition & 1 deletion DESCRIPTION
Original file line number Diff line number Diff line change
Expand Up @@ -32,7 +32,7 @@ Suggests:
Encoding: UTF-8
Language: en-GB
LazyData: true
RoxygenNote: 7.3.1
RoxygenNote: 7.3.2
Roxygen: list(markdown = TRUE)
URL: https://nutriverse.io/sleacr/,https://github.com/nutriverse/sleacr
BugReports: https://github.com/nutriverse/sleacr/issues
Expand Down
4 changes: 2 additions & 2 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -29,7 +29,7 @@ In the recent past, measurement of coverage has been mainly through two-stage cl

## Installation

The `sleacr` package is not yet available on [CRAN](https://cran.r-project.org) but can be installed from the [Nutriverse R universe](https://nutriverse.r-universe.dev) as follows:
The `sleacr` package is not yet available on [CRAN](https://cran.r-project.org) but can be installed from the [nutriverse R Universe](https://nutriverse.r-universe.dev) as follows:

```{r install, echo = TRUE, eval = FALSE}
install.packages(
Expand Down Expand Up @@ -60,5 +60,5 @@ citation("sleacr")

Feedback, bug reports, and feature requests are welcome; file issues or seek support [here](https://github.com/nutriverse/sleacr/issues). If you would like to contribute to the package, please see our [contributing guidelines](https://nutriverse.io/sleacr/CONTRIBUTING.html).

This project is released with a [Contributor Code of Conduct](https://contributor-covenant.org/version/2/1/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/sleacr/CODE_OF_CONDUCT.html). By contributing to this project, you agree to abide by its terms.

14 changes: 7 additions & 7 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,7 +35,7 @@ functions for use in conducting a SLEAC assessment.

The `sleacr` package is not yet available on
[CRAN](https://cran.r-project.org) but can be installed from the
[Nutriverse R universe](https://nutriverse.r-universe.dev) as follows:
[nutriverse R Universe](https://nutriverse.r-universe.dev) as follows:

``` r
install.packages(
Expand All @@ -51,12 +51,12 @@ sampling, data collection, and data analysis of a SLEAC survey. The
current version of the `sleacr` package currently provides the
following:

- Functions to calculate the sample size needed for a SLEAC survey;
- Functions to calculate the sample size needed for a SLEAC survey;

- Functions to draw a stage 1 sample for a SLEAC survey;
- Functions to draw a stage 1 sample for a SLEAC survey;

- Functions to determine the performance of chosen classifier cut-offs
for analysis of SLEAC survey data.
- Functions to determine the performance of chosen classifier cut-offs
for analysis of SLEAC survey data.

## Citation

Expand Down Expand Up @@ -92,5 +92,5 @@ would like to contribute to the package, please see our [contributing
guidelines](https://nutriverse.io/sleacr/CONTRIBUTING.html).

This project is released with a [Contributor Code of
Conduct](https://contributor-covenant.org/version/2/1/CODE_OF_CONDUCT.html).
By contributing to this project, you agree to abide by its terms.
Conduct](https://nutriverse.io/sleacr/CODE_OF_CONDUCT.html). By
contributing to this project, you agree to abide by its terms.
88 changes: 41 additions & 47 deletions pkgdown/_pkgdown.yml
Original file line number Diff line number Diff line change
Expand Up @@ -2,33 +2,27 @@ title: sleacr

url: https://nutriverse.io/sleacr/

development:
mode: auto

template:
bootstrap: 5
bootswatch: cosmo
theme: haddock
ganalytics: UA-102485058-6
bootswatch: pulse
theme: breeze-light
ganalytics: G-8JY8XQC801
bslib:
pkgdown-nav-height: 100px

navbar:
bg: success
type: light
structure:
left:
- home
- intro
- reference
- articles
- news
right:
- mastodon
- linkedin
- github
left: [home, intro, reference, articles, news]
right: [search, mastodon, github]
components:
mastodon:
icon: fab fa-mastodon fa-lg
href: https://fosstodon.org/@katilingban
linkedin:
icon: fab fa-linkedin fa-lg
href: https://www.linkedin.com/company/katilingban
href: https://fosstodon.org/@nutriverse

home:
links:
Expand All @@ -37,34 +31,34 @@ home:
href: https://www.fantaproject.org/sites/default/files/resources/SQUEAC-SLEAC-Technical-Reference-Oct2012_0.pdf

reference:
- title: Sample size estimation
contents:
- get_binom_hypergeom
- get_hypergeom
- get_hypergeom_cumulative
- get_n
- get_d
- get_n_cases
- get_n_clusters
- title: Stage 1 sampling
contents:
- get_sampling_interval
- select_random_start
- select_sampling_clusters
- create_sampling_list
- title: Coverage classifier
contents: classify_coverage
- title: Tests for SLEAC classifier performance
contents:
- make_data
- run_lqas
- simulate_lqas
- test_lqas_classifier
- get_class_prob
- print.lqasClass
- plot.lqasSim
- title: Datasets
contents:
- village_list
- survey_data
- title: Sample size estimation
contents:
- get_binom_hypergeom
- get_hypergeom
- get_hypergeom_cumulative
- get_n
- get_d
- get_n_cases
- get_n_clusters
- title: Stage 1 sampling
contents:
- get_sampling_interval
- select_random_start
- select_sampling_clusters
- create_sampling_list
- title: Coverage classifier
contents: classify_coverage
- title: Tests for SLEAC classifier performance
contents:
- make_data
- run_lqas
- simulate_lqas
- test_lqas_classifier
- get_class_prob
- print.lqasClass
- plot.lqasSim
- title: Datasets
contents:
- village_list
- survey_data

0 comments on commit 2cb2af9

Please sign in to comment.