Skip to content

Commit

Permalink
finalise refresh to ready for CRAN submission
Browse files Browse the repository at this point in the history
  • Loading branch information
ernestguevarra committed Apr 12, 2024
1 parent da6fa57 commit 4f97466
Show file tree
Hide file tree
Showing 4 changed files with 27 additions and 11 deletions.
4 changes: 3 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -16,11 +16,13 @@ knitr::opts_chunk$set(
# washdata: Urban Water and Sanitation Survey Dataset <img src="man/figures/logo.png" width="200" align="right" />

<!-- badges: start -->
[![CRAN](https://img.shields.io/cran/v/washdata.svg)](https://cran.r-project.org/package=washdata)
[![CRAN status](https://www.r-pkg.org/badges/version/micronutr)](https://CRAN.R-project.org/package=micronutr)
[![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/master/LICENSE.md)
[![CRAN](http://cranlogs.r-pkg.org/badges/washdata)](https://cran.r-project.org/package=washdata)
[![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/washdata)](https://cran.r-project.org/package=washdata)
[![R-CMD-check](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml)
[![CodeFactor](https://www.codefactor.io/repository/github/katilingban/washdata/badge)](https://www.codefactor.io/repository/github/katilingban/washdata)
[![DOI](https://zenodo.org/badge/115544360.svg)](https://zenodo.org/doi/10.5281/zenodo.4058889)
<!-- badges: end -->

This package contains four datasets from an urban water and sanitation survey in Dhaka, Bangladesh conducted by [Water and Sanitation for the Urban Poor](https://wsup.com) with technical support from [Valid International](http://www.validinternational.org) in March 2017.
Expand Down
22 changes: 13 additions & 9 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,11 +5,14 @@

<!-- badges: start -->

[![CRAN](https://img.shields.io/cran/v/washdata.svg)](https://cran.r-project.org/package=washdata)
[![CRAN
status](https://www.r-pkg.org/badges/version/micronutr)](https://CRAN.R-project.org/package=micronutr)
[![CRAN](https://img.shields.io/cran/l/washdata.svg)](https://github.com/katilingban/washdata/blob/master/LICENSE.md)
[![CRAN](http://cranlogs.r-pkg.org/badges/washdata)](https://cran.r-project.org/package=washdata)
[![CRAN](http://cranlogs.r-pkg.org/badges/grand-total/washdata)](https://cran.r-project.org/package=washdata)
[![R-CMD-check](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/katilingban/washdata/actions/workflows/R-CMD-check.yaml)
[![CodeFactor](https://www.codefactor.io/repository/github/katilingban/washdata/badge)](https://www.codefactor.io/repository/github/katilingban/washdata)
[![DOI](https://zenodo.org/badge/115544360.svg)](https://zenodo.org/doi/10.5281/zenodo.4058889)
<!-- badges: end -->

This package contains four datasets from an urban water and sanitation
Expand Down Expand Up @@ -66,21 +69,22 @@ follows:

``` r
citation("washdata")
#> To cite package 'washdata' in publications use:
#> To cite washdata in publications use:
#>
#> Guevarra E (2024). _washdata: Urban Water and Sanitation Survey
#> Dataset_. R package version 0.1.4, https://katilingban.io/washdata/,
#> <https://github.com/katilingban/washdata/>.
#> Ernest Guevarra (2024). _washdata: Urban Water and Sanitation Survey
#> Dataset_. doi:10.5281/zenodo.4058890
#> <https://doi.org/10.5281/zenodo.4058890>, R package version 0.1.4,
#> <https://katilingban.io/washdata/>.
#>
#> A BibTeX entry for LaTeX users is
#>
#> @Manual{,
#> title = {washdata: Urban Water and Sanitation Survey Dataset},
#> author = {Ernest Guevarra},
#> author = {{Ernest Guevarra}},
#> year = {2024},
#> note = {R package version 0.1.4,
#> https://katilingban.io/washdata/},
#> url = {https://github.com/katilingban/washdata/},
#> note = {R package version 0.1.4},
#> url = {https://katilingban.io/washdata/},
#> doi = {10.5281/zenodo.4058890},
#> }
```

Expand Down
2 changes: 1 addition & 1 deletion cran-comments.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ formatting updates.
* ubuntu-latest (on GitHub Actions), release, devel, and oldrelease
* mac-builder (release)
* win-builder (devel, release, oldrelease)
* rhub (windows-devel, fedora-devel, ubuntu-release)
* rhub (windows-devel, fedora-devel, linux-devel, macos-devel)

## R CMD check results

Expand Down
10 changes: 10 additions & 0 deletions inst/CITATION
Original file line number Diff line number Diff line change
@@ -0,0 +1,10 @@
bibentry(
bibtype = "Manual",
header = "To cite washdata in publications use:",
title = "washdata: Urban Water and Sanitation Survey Dataset",
author = person("Ernest Guevarra"),
year = "2024",
note = "R package version 0.1.4",
url = "https://katilingban.io/washdata/",
doi = "10.5281/zenodo.4058890"
)

0 comments on commit 4f97466

Please sign in to comment.