add placeholder citation, polish dataset

CITATION.cff

@@ -8,7 +8,7 @@ message: 'To cite package "waschoolpiracema" in publications use:'
 type: software
 license: CC-BY-4.0
 title: 'waschoolpiracema: WASH in Schools in Piracema, Brazil'
-version: 0.0.0.9000
+version: 0.0.1
 abstract: The main goal of this study was to describe the profile of schools from
   the basic education system in the municipality of Piracema (Minas Gerais, Brazil).
   Moreover, we also aimed to compare the characteristics of schools, with a special
@@ -35,7 +35,7 @@ authors:
   orcid: https://orcid.org/0009-0009-4546-7214
 repository-code: https://github.com/openwashdata/waschoolpiracema
 url: https://github.com/openwashdata/waschoolpiracema
-date-released: '2024-06-21'
+date-released: '2024-07-09'
 contact:
 - family-names: Tabin
   given-names: Alexis

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: waschoolpiracema
 Title: WASH in Schools in  Piracema, Brazil
-Version: 0.0.0.9000
+Version: 0.0.1
 Authors@R: c(
     person("Alexis", "Tabin", , "alexis.tabin@gmail.com", role = c("aut", "cre"),
            comment = c(ORCID = "0009-0004-4908-9250")),
@@ -19,6 +19,6 @@ Depends:
 LazyData: true
 Language: en-GB
 Config/Needs/website: rmarkdown
-Date: 2024-06-21
+Date: 2024-07-09
 URL: https://github.com/openwashdata/waschoolpiracema
 BugReports: https://github.com/openwashdata/waschoolpiracema/issues

R/waschoolpiracema.R

@@ -9,24 +9,24 @@
 #'   \item{sch_id}{Numerical code of the school}
 #'   \item{admin}{The administration of the school is federal (1); state (2); municipal (3), or private (4). Federal, state, and municipal schools are considered public.}
 #'   \item{loc}{The school is located in an urban (1) or rural area (2)}
-#'   \item{drink_water}{The school provides drinking water with quality suitable for human consumption (i.e., ingestion, preparation, and production of food) according to the Brazilian national water quality standards (former Portaria nº 2.914/2011 now Portaria de Consolidação nº5/2017) (1 – Yes; 0 – No)}
-#'   \item{public_water}{The water in the school is supplied by a public network (1 – Yes; 0 – No).  }
-#'   \item{borehole_water}{The water in the school is supplied by a borehole (1 – Yes; 0 – No)}
-#'   \item{well_water}{The water in the school is supplied by a cacimba, cistern, or well (1 – Yes; 0 – No)}
-#'   \item{surface_water}{The water in the school is supplied by surface water source (1 – Yes; 0 – No)}
-#'   \item{no_water}{There is no water supply in the school (1 – Yes; 0 – No) }
-#'   \item{sewage_rede_publica}{The school dispose their sewage into a public sewerage system (1 – Yes; 0 – No)}
-#'   \item{sewage_fossa_septica}{The school dispose their sewage into  septic tank (1 – Yes; 0 – No)}
-#'   \item{waste_servico_coleta}{The solid waste in the school is regularly collected by the public cleaning service (1 – Yes; 0 – No)}
-#'   \item{waste_queima}{The solid waste in the school is disposed in an area licensed by environmental agencies, intended to receive solid waste in a planned manner (e.g., landfills) (1 – Yes; 0 – No)}
-#'   \item{waste_enterra}{The solid waste in the school is burned or incinerated (1 – Yes; 0 – No)}
-#'   \item{waste_destino_final_publico}{The solid waste in the school is buried (1 – Yes; 0 – No)}
-#'   \item{waste_descarta_outra_area}{The solid waste in the school is disposed in another area (none of the other options) (1 – Yes; 0 – No)}
-#'   \item{sanitary}{The school is equipped with sanitary facilities for personal hygiene/physiological needs (1 – Yes; 0 – No)}
-#'   \item{sanitary_ei}{The school is equipped with sanitary facilities for children 0 to 5 years old (1 – Yes; 0 – No)}
-#'   \item{sanitary_pne}{The school is equipped with disability-friendly sanitary facilities following the national guidelines (ABNT - NBR 9050) (1 – Yes; 0 – No)}
-#'   \item{sanitary_funcionarios}{The school is equipped with  sanitary facilities for personal hygiene/physiological needs exclusively for staff (1 – Yes; 0 – No)}
-#'   \item{sanitary_chuveiro}{The school is equipped with  sanitary facilities or changing room or washing room with appropriate equipment (shower) for bathing, exclusively for students (1 – Yes; 0 – No)}
+#'   \item{drink_water}{The school provides drinking water with quality suitable for human consumption (i.e., ingestion, preparation, and production of food) according to the Brazilian national water quality standards (former Portaria nº 2.914/2011 now Portaria de Consolidação nº5/2017) }
+#'   \item{public_water}{The water in the school is supplied by a public network .  }
+#'   \item{borehole_water}{The water in the school is supplied by a borehole}
+#'   \item{well_water}{The water in the school is supplied by a cacimba, cistern, or well }
+#'   \item{surface_water}{The water in the school is supplied by surface water source}
+#'   \item{no_water}{There is no water supply in the school}
+#'   \item{sewage_rede_publica}{The school dispose their sewage into a public sewerage system}
+#'   \item{sewage_fossa_septica}{The school dispose their sewage into  septic tank}
+#'   \item{waste_servico_coleta}{The solid waste in the school is regularly collected by the public cleaning service}
+#'   \item{waste_queima}{The solid waste in the school is disposed in an area licensed by environmental agencies, intended to receive solid waste in a planned manner (e.g., landfills) }
+#'   \item{waste_enterra}{The solid waste in the school is burned or incinerated}
+#'   \item{waste_destino_final_publico}{The solid waste in the school is buried}
+#'   \item{waste_descarta_outra_area}{The solid waste in the school is disposed in another area (none of the other options)}
+#'   \item{sanitary}{The school is equipped with sanitary facilities for personal hygiene/physiological needs}
+#'   \item{sanitary_ei}{The school is equipped with sanitary facilities for children 0 to 5 years old}
+#'   \item{sanitary_pne}{The school is equipped with disability-friendly sanitary facilities following the national guidelines (ABNT - NBR 9050)}
+#'   \item{sanitary_funcionarios}{The school is equipped with  sanitary facilities for personal hygiene/physiological needs exclusively for staff}
+#'   \item{sanitary_chuveiro}{The school is equipped with  sanitary facilities or changing room or washing room with appropriate equipment (shower) for bathing, exclusively for students}
 #'   \item{qt_mat_bas}{Total number of students per school}
 #'   \item{pc_girl}{Percentage of girls per school}
 #'   \item{pc_boy}{Percentage of boys per school}

README.Rmd

@@ -31,7 +31,7 @@ knitr::opts_chunk$set(
 
 <!-- badges: end -->
 
-The goal of `waschoolpiracema` is to describe the profile of schools from the basic education system in the municipality of Piracema (Minas Gerais, Brazil). Moreover, we also aimed to compare the characteristics of schools, with a special concern to WASH, pre- (2020), peri- (2021) and post-COVID-19 pandemic (2022) to evaluate to what extend schools in Piracema made progress in providing WASH since the beginning of the COVID-19 pandemic.
+The goal of `waschoolpiracema` is to describe the profile of schools from the basic education system in the municipality of Piracema (Minas Gerais, Brazil). Moreover, the data compare the characteristics of schools, with a special concern to WASH, pre- (2020), peri- (2021) and post-COVID-19 pandemic (2022) to evaluate to what extend schools in Piracema made progress in providing WASH since the beginning of the COVID-19 pandemic.
 
 ## Installation
 
@@ -75,7 +75,9 @@ read_csv("data-raw/dictionary.csv") |>
 
 ## Data
 
-The package provides access to meaningful information on the municipality of Piracema. Located in the southeast region of Brazil, in the state of Minas Gerais, Piracema is a small size city adding up to 6,700 inhabitants (IBGE, 2023). Among all Brazilian territories, it ranks as the 3,734º smallest municipality out of 5,570 and in Minas Gerais it ranks as the 492º out of 853 (IBGE, 2023). Piracema is located approximately 120 km away from the capital of its state (Belo Horizonte), and it is inaccessible by public transportation (IBGE, 2023). Piracema will be the study area for the next phase of the research (collection of primary data).
+The municipality of Piracema is located in the southeast region of Brazil, in the state of Minas Gerais. Piracema is a small size city adding up to 6,700 inhabitants (IBGE, 2023). Among all Brazilian territories, it ranks as the 3,734º smallest municipality out of 5,570 and in Minas Gerais it ranks as the 492º out of 853 (IBGE, 2023). 
+
+Piracema is located approximately 120 km away from the capital of its state (Belo Horizonte), and it is inaccessible by public transportation (IBGE, 2023). Piracema will be the study area for the next phase of the research (collection of primary data).
 
 ```{r}
 library(waschoolpiracema)
@@ -158,7 +160,7 @@ sanitary_sewage_waste_cols <- c(
 )
 
 # Convert relevant columns to integers
-waschoolpiracema[sanitary_sewage_waste_cols] <- lapply(waschoolpiracema[sanitary_sewage_waste_cols], function(x) as.integer(as.character(x)))
+waschoolpiracema[sanitary_sewage_waste_cols] <- lapply(waschoolpiracema[sanitary_sewage_waste_cols], function(x) as.integer(x))
 
 # Summarize the waschoolpiracema data to get the count and percentage of schools with facilities per year
 summary_data <- waschoolpiracema %>%
@@ -211,7 +213,7 @@ ggplot(summary_data, aes(x = factor(year), y = percentage, color = race, group =
 water_cols <- c("drink_water", "public_water", "borehole_water", "well_water", "surface_water", "no_water")
 
 # Convert relevant columns to integers
-waschoolpiracema[water_cols] <- lapply(waschoolpiracema[water_cols], function(x) as.integer(as.character(x)))
+waschoolpiracema[water_cols] <- lapply(waschoolpiracema[water_cols], function(x) as.integer((x)))
 
 # Summarize the data to get the count and percentage of schools with each type of water supply per year
 summary_data <- waschoolpiracema %>%
@@ -243,6 +245,8 @@ ggplot(summary_data, aes(x = factor(year), y = count, fill = water_supply)) +
 
 This dataset is shared as part of a capstone project in [Data Science for openwashdata](https://ds4owd-001.github.io/website/). For more information about the project and to explore further insights, please visit the project page at https://ds4owd-001.github.io/project-poaguek/ (to be public available)
 
+This study is a sub-project of a PhD project. It is also an initial study comparing the BNSC from 2020 and 2021(#TODO: add reference). Findings will be essential for the next phase of the research, which will be the collection of primary data in schools in the municipality of Piracema through qualitative methods (interviews, on-spot observations and art-based research).
+
 ## License
 
 Data are available as