README.Rmd

---
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%"
)
```

# fmi2 - R client for the Finnish Meteorological Institute's (FMI) API <a href='https://ropengov.github.io/fmi2/'><img src='man/figures/logo.png' align="right" height="139" /></a>

<!-- badges: start -->
[![rOG-badge](https://ropengov.github.io/rogtemplate/reference/figures/ropengov-badge.svg)](http://ropengov.org/)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html)
[![codecov](https://codecov.io/gh/rOpenGov/fmi2/branch/master/graph/badge.svg)](https://app.codecov.io/gh/rOpenGov/fmi2)
[![CRAN status](https://www.r-pkg.org/badges/version/fmi2)](https://CRAN.R-project.org/package=fmi2)
[![R build status](https://github.com/rOpenGov/fmi2/workflows/R-CMD-check/badge.svg)](https://github.com/rOpenGov/fmi2/actions)

<!-- badges: end -->

R client package for [the Finnish Meteorological Institute (FMI) open data API](https://en.ilmatieteenlaitos.fi/open-data-manual). `fmi2` provides access
to a subset of the FMI [download](https://en.ilmatieteenlaitos.fi/open-data-manual-accessing-data) 
service. FMI maintains and is reponsible for the data available through their
API, but has no official connections to `fmi2`. 

All data from the FMI is released under [the Creative Commons Attribution 4.0 
International license](https://creativecommons.org/licenses/by/4.0/).

## Installation

`fmi2` is not yet on CRAN, but you can install the development version 
from [GitHub](https://github.com/rOpenGov/fmi2) with:

```{r install, eval=FALSE}
# install.packages("remotes")
remotes::install_github("rOpenGov/fmi2")
```

## Details

Currently, the following FMI stored queries are avaible in `fmi2`:

```{r function-table, echo=FALSE}
library(fmi2)
knitr::kable(list_queries(),
             col.names = c("Stored query", "Description", "No. parameters",
                           "fmi2 function name"))

```


More data sets and queries may be wrapped in the future.

## Example

For usage examples, see the package [function reference](https://ropengov.github.io/fmi2//reference/index.html) and the following vignettes:

- [Getting weather observation data](https://ropengov.github.io/fmi2//articles/weather_observation_data.html)

## Contributing

If you have a particular need in mind, you're free to:

1. Fork the repository, modify the code and leave a pull request.
2. Leave an [issue](https://github.com/rOpenGov/fmi2/issues) with a description
on the improvements.

## Why fmi2?

If this is `fmi2`, where's the first `fmi`!? Good question, `fmi` can be found
[here](https://github.com/rOpenGov/fmi) and is no longer developed or 
maintained. `fmi` was developed back in the day when accessing data from a 
WFS in R was much more difficult. Hence, the package is much more complicated
than `fmi2` and too laborious to maintain.