An open API service indexing awesome lists of open source software.

https://github.com/beatrizmilz/mananciais

Base de dados sobre volume operacional em mananciais de abastecimento público na Região Metropolitana de São Paulo (SP - Brasil).
https://github.com/beatrizmilz/mananciais

git-scraping

Last synced: 11 months ago
JSON representation

Base de dados sobre volume operacional em mananciais de abastecimento público na Região Metropolitana de São Paulo (SP - Brasil).

Awesome Lists containing this project

README

          

---
output: github_document
---

```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```

# Pacote Mananciais

[![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)

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)