NOTE: THIS IS A WORK IN PROGRESS.
Add an good introduction of the package.
Installation
To install the forcis package, run:
## Install < remotes > package (if not already installed) ----
if (!requireNamespace("remotes", quietly = TRUE)) {
install.packages("remotes")
}
## Install dev version of < forcis > from GitHub ----
remotes::install_github("FRBCesab/forcis")The forcis package depends on the sf package which
requires some spatial system libraries (GDAL and PROJ). Please read this
page if you have any trouble to install forcis.
Download FORCIS database
Before going any further, we will download the latest version of the FORCIS database.
# Create a data/ folder ----
dir.create("data")
# Download latest version of the database ----
download_forcis_db(path = "data", version = NULL)Import FORCIS data
The vignette will use the PUMP data of the FORCIS database. Let’s import the latest release of the data.
# Import pump data ----
pump_data <- read_pump_data(path = "data")NB: In this vignette, we use a subset of the PUMP data, not the whole dataset.