-
Notifications
You must be signed in to change notification settings - Fork 0
/
README.Rmd
79 lines (59 loc) · 2.55 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
---
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%"
)
```
# dbrenovaveis
<!-- badges: start -->
[](https://github.com/lkhenayfis/dbrenovaveis/actions)
[](https://github.com/lkhenayfis/dbrenovaveis/actions)
[](https://codecov.io/gh/lkhenayfis/dbrenovaveis)
<!-- badges: end -->
## Visao geral
Este pacote fornece funcionalidade backend para interface com bancos localizados em um diretorio
local ou em um bucket S3. A versao atual suporta particionamento de dados, porem apenas operacoes de
leitura estao implementadas. Criacao de novas tabelas e escrita nas existentes serao adicionadas em
versoes futuras.
## Instalacao
Este pacote ainda nao se encontra disponibilizado no CRAN, de modo que deve ser instalado
diretamente a partir do repositorio utilizando:
```{r intro, eval = FALSE}
# Caso a biblioteca remotes nao esteja instalada, execute install.packages("remotes") primeiro
remotes::install_github("lkhenayfis/dbrenovaveis") # instalacao da versao de desenvolvimento
remotes::install_github("lkhenayfis/dbrenovaveis@*release") # instalacao da ultima versao fechada
```
## Exemplo de uso
Neste exemplo de uso sera utilizado o banco exemplo contido no pacote. Para mais informacoes sobre
como construir um banco proprio ou acessos a dados em um bucket S3, consulte a vignette e paginas de
documentacao pertinentes.
O primeiro passo para acesso aos dados em um determinado banco e estabeler uma conexao com o mesmo.
```{r,echo=FALSE}
library(dbrenovaveis)
```
```{r}
dir_banco_local <- system.file("extdata/cpart_parquet", package = "dbrenovaveis")
conexao <- conectamock(dir_banco_local)
```
Um `print` do objeto de conexao exibe as tabelas disponiveis, bem como suas colunas
```{r}
print(conexao)
```
A partir deste ponto e possivel acessar os dados do banco utilizando a funcao `getfromdb`
```{r}
# lendo tabela completa
dat <- getfromdb(conexao, tabela = "subbacias")
print(dat)
```
Subsets podem ser especificados no momento da leitura atraves de argumentos opcionais nomeados
homonimos das colunas na tabela
```{r}
dat <- getfromdb(conexao, tabela = "subbacias", codigo = c("AVERMELHA", "BAIXOIG"))
print(dat)
```