update readme

README.Rmd

@@ -130,8 +130,12 @@ This dataset is shared as part of a capstone project in Data Science for openwas
 ## Methodology
 The data was obtained from @SIASAR, an information system containing data on rural water supply and sanitation services. Using SIASAR's "download data by country" tool, all available data for Peru (10 excel files) were downloaded. After examining the 10 excel files, only 5 pertained to potable water systems. Those 5 data sets were imported into R and subsequently empty values and unnecessary columns were deleted from them. Finally, the 5 data sets were combined into 1 data frame based on community ID. The combined, cleaned data set contains data from 32 communities.
 
-Documentaion of the dataset went through:
-https://globalsiasar.org/sites/default/files/documents/water_supply_system_v10.pdf
+SIASAR does not provide a matching data dictionary. openwashdata developer went through the attachements of the original questionnaire:
+
+- https://globalsiasar.org/es/content/documentacion-tecnica
+- https://globalsiasar.org/en/content/technical-documentation
+
+The variable description is written with our best guess with the information from the attachements.
 
 ## License
 

README.md

@@ -7,7 +7,7 @@
 
 [![License: CC BY
 4.0](https://img.shields.io/badge/License-CC_BY_4.0-lightgrey.svg)](https://creativecommons.org/licenses/by/4.0/)
-
+[![R-CMD-check](https://github.com/openwashdata/portawaterperu/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/openwashdata/portawaterperu/actions/workflows/R-CMD-check.yaml)
 <!-- badges: end -->
 
 The goal of the package `portawaterperu` is to provide access to data
@@ -64,7 +64,7 @@ portawaterperu |>
   gt::as_raw_html()
 ```
 
-<div id="eouknuqrfo" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
+<div id="rutvwqeijw" style="padding-left:0px;padding-right:0px;padding-top:10px;padding-bottom:10px;overflow-x:auto;overflow-y:auto;width:auto;height:auto;">
   &#10;  <table class="gt_table" data-quarto-disable-processing="false" data-quarto-bootstrap="false" style="-webkit-font-smoothing: antialiased; -moz-osx-font-smoothing: grayscale; font-family: system-ui, 'Segoe UI', Roboto, Helvetica, Arial, sans-serif, 'Apple Color Emoji', 'Segoe UI Emoji', 'Segoe UI Symbol', 'Noto Color Emoji'; display: table; border-collapse: collapse; line-height: normal; margin-left: auto; margin-right: auto; color: #333333; font-size: 16px; font-weight: normal; font-style: normal; background-color: #FFFFFF; width: auto; border-top-style: solid; border-top-width: 2px; border-top-color: #A8A8A8; border-right-style: none; border-right-width: 2px; border-right-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #A8A8A8; border-left-style: none; border-left-width: 2px; border-left-color: #D3D3D3;" bgcolor="#FFFFFF">
   <thead style="border-style: none;">
     <tr class="gt_col_headings" style="border-style: none; border-top-style: solid; border-top-width: 2px; border-top-color: #D3D3D3; border-bottom-style: solid; border-bottom-width: 2px; border-bottom-color: #D3D3D3; border-left-style: none; border-left-width: 1px; border-left-color: #D3D3D3; border-right-style: none; border-right-width: 1px; border-right-color: #D3D3D3;">
@@ -916,8 +916,14 @@ from them. Finally, the 5 data sets were combined into 1 data frame
 based on community ID. The combined, cleaned data set contains data from
 32 communities.
 
-Documentaion of the dataset went through:
-<https://globalsiasar.org/sites/default/files/documents/water_supply_system_v10.pdf>
+SIASAR does not provide a matching data dictionary. openwashdata
+developer went through the attachements of the original questionnaire:
+
+- <https://globalsiasar.org/es/content/documentacion-tecnica>
+- <https://globalsiasar.org/en/content/technical-documentation>
+
+The variable description is written with our best guess with the
+information from the attachements.
 
 ## License
 
@@ -934,15 +940,15 @@ citation("portawaterperu")
 #> 
 #>   Judah L, Loos S, Zhong M (2024). _portawaterperu: A Preliminary
 #>   Review of Peruvian Potable Water System Data_. R package version
-#>   0.0.0.9000, <https://github.com/openwashdata/portawaterperu>.
+#>   0.0.1, <https://github.com/openwashdata/portawaterperu>.
 #> 
 #> A BibTeX entry for LaTeX users is
 #> 
 #>   @Manual{,
 #>     title = {portawaterperu: A Preliminary Review of Peruvian Potable Water System Data},
 #>     author = {Lauren Judah and Sebastian Camilo Loos and Mian Zhong},
 #>     year = {2024},
-#>     note = {R package version 0.0.0.9000},
+#>     note = {R package version 0.0.1},
 #>     url = {https://github.com/openwashdata/portawaterperu},
 #>   }
 ```

docs/pkgdown.yml

@@ -2,7 +2,7 @@ pandoc: 3.1.11
 pkgdown: 2.0.9
 pkgdown_sha: ~
 articles: {}
-last_built: 2024-07-24T19:06Z
+last_built: 2024-07-24T22:09Z
 urls:
   reference: https://github.com/openwashdata/portawaterperu/reference
   article: https://github.com/openwashdata/portawaterperu/articles