Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.

Awesome Lists | Featured Topics | Projects

https://github.com/inbo/n2khelper

natura2000 package r

Last synced: about 2 months ago
JSON representation

Host: GitHub
URL: https://github.com/inbo/n2khelper
Owner: inbo
License: gpl-3.0
Created: 2016-01-28T09:18:03.000Z (almost 9 years ago)
Default Branch: main
Last Pushed: 2023-05-24T08:55:31.000Z (over 1 year ago)
Last Synced: 2024-05-01T12:39:52.654Z (8 months ago)
Topics: natura2000, package, r
Language: R
Size: 498 KB
Stars: 0
Watchers: 5
Forks: 1
Open Issues: 0
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- License: LICENSE.md
- Code of conduct: .github/CODE_OF_CONDUCT.md
- Citation: CITATION.cff

Awesome Lists containing this project

README

        [![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)

[![License](https://img.shields.io/badge/license-GPL--3-blue.svg?style=flat)](https://www.gnu.org/licenses/gpl-3.0.html)

[![DOI](https://zenodo.org/badge/50571210.svg)](https://zenodo.org/badge/latestdoi/50571210)

[![codecov](https://codecov.io/gh/inbo/n2khelper/branch/master/graph/badge.svg)](https://app.codecov.io/gh/inbo/n2khelper)

# 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](https://github.com/search?q=topic%3Anatura2000+org%3Ainbo&type=Repositories) created to analyse the data gathered during the Natura 2000 monitoring.

- [n2kanalysis](https://github.com/inbo/n2kanalysis): R package with generic functions for the analysis

- [watervogelanalysis](https://github.com/inbo/watervogelanalysis): R package to extract the raw data from the wintering bird survey database and prepare the analyses

- [abvanalysis](https://github.com/inbo/abvanalysis): R package to extract the raw data from the common breeding birds survey database and prepare the analyses

- [n2khelper](https://github.com/inbo/n2khelper): auxiliary functions used in the other packages

- [n2kresult](https://github.com/inbo/n2kresult): Liquibase scripts to setup the database in which the results of the analyses are stored

- [n2kupdate](https://github.com/inbo/n2kupdate): R package to read and write to the `n2kresult` database

- [Rn2k](https://github.com/inbo/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.

1. Put functions together which might be relevant for other users and package authors.

1. 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()`](https://github.com/eddelbuettel/digest/pull/20) and [`aws.s3::get_bucket()`](https://github.com/cloudyr/aws.s3/pull/104)

## 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

```