-
Notifications
You must be signed in to change notification settings - Fork 2
/
README.Rmd
88 lines (57 loc) · 3.47 KB
/
README.Rmd
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# Pacote Mananciais <img src="man/figures/hexlogo.png" align="right" width = "120px"/>
<!-- badges: start -->
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4733056.svg)](https://doi.org/10.5281/zenodo.4733056) [![R build status](https://github.com/beatrizmilz/mananciais/workflows/R-CMD-check/badge.svg)](https://github.com/beatrizmilz/mananciais/actions) [![update-data](https://github.com/beatrizmilz/mananciais/actions/workflows/2-update_data.yaml/badge.svg)](https://github.com/beatrizmilz/mananciais/actions/workflows/2-update_data.yaml) [![Codecov test coverage](https://codecov.io/gh/beatrizmilz/mananciais/branch/master/graph/badge.svg)](https://codecov.io/gh/beatrizmilz/mananciais?branch=master)
<!-- badges: end -->
O objetivo deste pacote é disponibilizar a base de dados sobre o volume operacional em mananciais de abastecimento público na Região Metropolitana de São Paulo (SP - Brasil). O pacote é atualizado diariamente através de um workflow com [GitHub Actions](https://github.com/beatrizmilz/mananciais/actions).
Os dados foram obtidos no [Portal dos Mananciais](http://mananciais.sabesp.com.br/Situacao) da [SABESP](http://site.sabesp.com.br/site/Default.aspx).
Este pacote foi derivado de um código web scraping desenvolvido pela equipe da [Curso-R](https://www.curso-r.com/), em uma [live](https://youtu.be/jvZIxrMmOcQ), e o código original está disponível [neste link](https://github.com/curso-r/lives/blob/master/drafts/20200730_scraper_sabesp.R).
Este pacote foi criado no âmbito da [pesquisa de doutorado de Beatriz Milz](https://beatrizmilz.github.io/tese/).
__Caso você não utilize R__, é possível __fazer download da base de dados__ através dos seguintes links:
- [Arquivo `.csv`](https://github.com/beatrizmilz/mananciais/raw/master/inst/extdata/mananciais.csv)
- [Arquivo `.xlsx`](https://github.com/beatrizmilz/mananciais/blob/master/inst/extdata/mananciais.xlsx?raw=true)
Os arquivos foram salvos com encoding UTF-8, e separados por ponto-e-vírgula.
## Instalação
Este pacote pode ser instalado através do [GitHub](https://github.com/) utilizando o seguinte código em `R`:
``` r
# install.packages("devtools")
devtools::install_github("beatrizmilz/mananciais")
library(mananciais)
```
## Como usar?
Caso você tenha conexão à internet, é possível buscar a base atualizada usando a função `dados_mananciais()`:
```{r}
mananciais <- mananciais::dados_mananciais()
```
Caso você não tenha conexão à internet, você pode utilizar a base
disponível no pacote. Porém as mesmas estarão atualizadas até a data em
que você instalou (ou atualizou) o pacote.
Abaixo segue um exemplo da base disponível:
```{r example}
dplyr::glimpse(mananciais)
```
Caso queira saber o significado de cada variável, leia a [documentação da base de dados](https://beatrizmilz.github.io/mananciais/reference/mananciais.html) ou utilize a seguinte função:
```r
?mananciais::mananciais
```
### Exemplo de tabela
```{r eval=TRUE, message=FALSE, warning=FALSE, include=TRUE}
library(magrittr)
mananciais %>%
dplyr::arrange(desc(data)) %>%
head(7) %>%
knitr::kable()
```
## Como citar o pacote
[![DOI](https://zenodo.org/badge/DOI/10.5281/zenodo.4733056.svg)](https://doi.org/10.5281/zenodo.4733056)