README.md

In inbo/n2khelper: Auxiliary Functions for the Analysis and Reporting of the Natura 2000 Monitoring

The n2khelper package

The n2khelper package contains auxiliary functions for the analysis and reporting of the Natura 2000 Monitoring.

Rationale

n2khelper is part of the collection of R packages created to analyse the data gathered during the Natura 2000 monitoring.

• n2kanalysis: R package with generic functions for the analysis
• watervogelanalysis: R package to extract the raw data from the wintering bird survey database and prepare the analyses
• abvanalysis: R package to extract the raw data from the common breeding birds survey database and prepare the analyses
• n2khelper: auxiliary functions used in the other packages
• n2kresult: Liquibase scripts to setup the database in which the results of the analyses are stored
• n2kupdate: R package to read and write to the n2kresult database
• Rn2k: Docker image with all the required dependencies to run the analyses

n2khelper has several goals:

1. Not to repeat oneself by creating a single package with generic function rather than create different functions that do something similar in the different packages.
2. Put functions together which might be relevant for other users and package authors.
3. Create a proof of concept for some functionality and convince authors of more estabiled packages to incoporate them in their package. Examples are digest::sha1() and aws.s3::get_bucket()

Folder structure

The folder structure is that of a typical R packages with the mandatory R folder (definition of the functions) and man (helpfiles in Rd format). data-raw is an optional folder with the source code the generate sysdata.rda in the R folder. The optional test folder contains the unit tests using the infrastructure from the testthat package.

n2khelper
|-- data-raw
|-- man
|-- R
|-- tests
   |-- testthat

inbo/n2khelper documentation built on March 26, 2022, 1:51 p.m.