README.Rmd

---
output: rmarkdown::github_document
editor_options: 
  chunk_output_type: console
---
```{r pkg-knitr-opts, include=FALSE}
hrbrpkghelpr::global_opts()
```

```{r badges, results='asis', echo=FALSE, cache=FALSE}
hrbrpkghelpr::stinking_badges()
```

```{r description, results='asis', echo=FALSE, cache=FALSE}
hrbrpkghelpr::yank_title_and_description()
```

## What's Inside The Tin

The following functions are implemented:

```{r ingredients, results='asis', echo=FALSE, cache=FALSE}
hrbrpkghelpr::describe_ingredients()
```

### TODO

Cover the following API endpoints:

- Parameterized [`/observations/device/{device_id}`](https://weatherflow.github.io/Tempest/api/swagger/#!/observations/getObservationsByDeviceId)
- Support units parameters for[`/better_forecast`](https://weatherflow.github.io/Tempest/api/swagger/#!/forecast/getBetterForecast)
- Add names to unnamed observations results

## Installation

```{r install-ex, results='asis', echo=FALSE, cache=FALSE}
hrbrpkghelpr::install_block()
```

## Usage

```{r lib-ex}
library(tempestwx)

# current version
packageVersion("tempestwx")

```

### Station Metadata

```{r ex-01}
st <- tempest_station_meta()

str(st)
```

### Latest Observations

```{r ex-02}
str(
  latest_observation(st$stations$station_id)
)
```

### Device Observations

```{r ex-03}
str(
  latest_device_observation(st$stations$devices[[1]]$device_id[2])$obs
)
```

### Latest Forecast

```{r ex-04}
knitr::kable(
  latest_forecast(st$stations$station_id[1])$forecast,
  format = "markdown"
)
```

## tempestwx Metrics

```{r cloc, echo=FALSE}
cloc::cloc_pkg_md()
```

## Code of Conduct

Please note that this project is released with a Contributor Code of Conduct. 
By participating in this project you agree to abide by its terms.