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

# forestdata <a href="https://cidree.github.io/forestdata/"><img src="man/figures/logo.png" align="right" height="138" alt="forestdata website" /></a>

<!-- badges: start -->
[![CRAN status](https://www.r-pkg.org/badges/version/forestdata)](https://CRAN.R-project.org/package=forestdata)
[![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental)
[![Codecov test coverage](https://codecov.io/gh/Cidree/forestdata/graph/badge.svg)](https://app.codecov.io/gh/Cidree/forestdata)
[![License: GPL v3](https://img.shields.io/badge/License-GPLv3-blue.svg)](https://www.gnu.org/licenses/gpl-3.0)
[![Project Status: Active – The project has reached a stable, usable state and is being actively developed.](https://www.repostatus.org/badges/latest/active.svg)](https://www.repostatus.org/#active)
<!-- badges: end -->

`forestdata` is an R package for downloading forestry and land use data. This package aims to provide users with easy access to various datasets related to forestry and land use.

## Installation

You can install the latest version in CRAN using:

```r
pak::pak("forestdata")
```

Or you can install the development version using:

``` r
pak::pak("Cidree/forestdata")
```

## Functions

In the following table, you can find a summary of the available
functions, a short description, and the object type of the output.

::: {align="center"}
<img src="man/figures/functions_gt.png" width="800px"/>
:::

## Note

Please read the function documentation carefully. Some datasets may
require proper citation when used.