README.md

smapOnsR

Pacote com a implementacao em R do modelo SMAP/ONS

Instalação

Para a instalacao do pacote no Windows, e necessaria a instalacao do programa Rtools, de mesma versao do R: https://cran.r-project.org/bin/windows/Rtools/ Este pacote ainda nao se encontra disponibilizado no CRAN, de modo que deve ser instalado diretamente a partir do repositorio. Para a versao oficial, deve-se utilizar o seguinte comando

# install.packages("devtools")
devtools::install_github("ONSBR/[email protected]")

Para a versao em desenvolvimento, deve-se utilizar o seguinte comando:

# install.packages("devtools")
devtools::install_github("ONSBR/smapOnsR")

Imagem Docker

É disponibilizada uma imagem com o intepretador da linguagem R a partir da imagem no rocker/tidyverse com o smapOnsR instalado, juntamente com todas as suas dependências. A imagem está disponível em onstec/smaponsr e pode ser utilizada por qualquer usuário para construir suas aplicações containerizadas. Um exemplo de Dockerfile utilizando a imagem, assumindo que todo o código que faz uso do smapOnsR está no arquivo main.R:

FROM onstec/smaponsr:latest

WORKDIR /app

COPY main.R .

CMD ["Rscript", "main.R"]

Exemplo

Exemplo de como executar um caso com os dados de entrada oficiais.

library(smapOnsR)
## Executar linha abaixo
zip::unzip(system.file("extdata", "dados_entrada.zip", package = "smapOnsR"), exdir = system.file("extdata", package = "smapOnsR"))
pasta_entrada <- system.file("extdata", "caso_completo2", package = "smapOnsR")

executa_caso_oficial(pasta_entrada)

Exemplo de como executar um caso com os dados de entrada novos.

library(smapOnsR)
## Executar linha abaixo
pasta_entrada <- system.file("extdata", "arq_entrada_novo", package = "smapOnsR")

saida <- executa_caso_novo(pasta_entrada)