README.Rmd

---
output:
  md_document:
    variant: markdown_github
---

```{r, echo = FALSE}
knitr::opts_chunk$set(
  collapse = TRUE,
  comment = "#>",
  fig.path = "README-"
)
```

# cptec

[![CRAN\_Status\_Badge](https://www.r-pkg.org/badges/version/cptec)](https://CRAN.R-project.org/package=cptec)
[![CRAC\_Downloads](https://cranlogs.r-pkg.org/badges/grand-total/cptec)](https://CRAN.R-project.org/package=cptec)

The goal of *cptec* is to allows the user to retrieve data from the
CPTEC/INPE weather forecast API. CPTEC stands for 'Centro de Previsão 
de Tempo e Estudos Climáticos' and INPE for 'Instituto Nacional de 
Pesquisas Espaciais'. CPTEC is the most advanced numerical weather and 
climate forecasting center in Latin America, with high-precision short
and medium-term weather forecasting since the beginning of 1995. See
<https://www.cptec.inpe.br/> for more information.

## Installation

Install the release version from CRAN:

```{r , eval = FALSE}
install.packages("cptec")
```

or the development version from github

```{r , eval = FALSE}
# install.packages("devtools")
devtools::install_github("rpradosiqueira/cptec")
```

## Functions

The "cptec" package contains the functions:

```{r, eval=FALSE}
prev4dias          It retrieve 4 days weather forecast data
                   according to the 'id' provided
                   
prev7dias          It retrieve 7 days weather forecast data
                   according to the 'id' provided
                   
listaCidades       It allows the user to discover which are
                   the city`s ID of interest

metar              It allows the user to retrieve data from
                   airport surface stations
                   
ondas              It allows the user to retrieve data from
                   sea waves
                   
prevEstendida      It retrieve 14 days weather forecast data
                   according to the 'id' provided
                    
prevLatLon         It retrieve 7 days weather forecast data
                   according to the latitude/longitude provided
                   
estendidaLatLon    It retrieve 14 days weather forecast data
                   according to the latitude/longitude provided
                   
iuv                It retrieve the last updated data from CPTEC/INPE
                   ultra violet index for a determined city
                   
estacoes_metar     List "Metar" initials and descriptions

condicoes_tempo    List "tempo" descriptions

capitais           It allows the user to retrieve data from
                   current weather conditions of capitals
```		   

## Example

Let's assume that we want the next 7 days weather forecast for the city of Rio de Janeiro/RJ. To do this simply execute:

```{r}
library(cptec)

prev7dias(id = 241)

```