README.md

{aspe}: an R package to analyse and visualise river fish data in France

{aspe} fournit des outils autorisant simplement la plupart des traitements de base à partir d’une sauvegarde (dump SQL) de la base de données ASPE de l’OFB. Ces traitements comprennent les calculs d’abondances, densités, distribution en tailles et la détection de tendances à l’échelle de la station. Ces calculs sont accompagnés de fonctionnalités graphiques.

The goal of {aspe} is to is to provide a suite of tools for most of the common processing of the ASPE database including importation from a SQL format dump, calculation of abundances, densities, size distributions, temporal trends for populations at the station level, along with graphical output.

La base de données ASPE de l’OFB contient toutes les données d’inventaire par pêche à l’électricité par le CSP, l’ONEMA, l’AFB, l’OFB ainsi que par certains partenaires sur les rivières de France. Elle est décrite dans Irz et al. (2022), article produit en visant le respect des principes de la recherche reproductible (Wilkinson et al. 2016). Ses fichiers sources - données comprises - sont diffusés sur le dépôt

The ASPE database is administrated by the French Office for Biodiversity. It gathers, among others, all the river electrofishing samplings carried out by the former Fisheries Council, National Office for Water and Aquatic Systems and French Agency for Biodiversity. The database is described in Irz et al. (2022). This paper was produced to respect the FAIR principles (Wilkinson et al. 2016), hence its source files - including the database - are available at

• Irz P, Vigneron T, Poulet N, Cosson E, Point T, Baglinière E, Porcher JP. 2022. A long-term monitoring database on fish and crayfish species in French rivers. Knowl. Manag. Aquat. Ecosyst. 423, 25, DOI:10.1051/kmae/2022021.
• Wilkinson MD, et al. 2016. The FAIR Guiding Principles for scientific data management and stewardship. Sci. Data 3: 160018, DOI:10.1038/sdata.2016.18.

Installation

Si besoin, commencer par installer le package R {devtools} ainsi que la suite Rtools, puis installer {aspe} au moyen de la commande :

If necessary, first install the {devtools} R package and the Rtools suite, then you can install the released version of {aspe} from Github with:

devtools::install_github("PascalIrz/aspe")

Répertoires Github associés / Associated Github repositories

Plusieurs dépôts Github sont associés au package :

• aspe_data : construction des jeux de données inclus dans le package {aspe}
• aspe_test : Fichiers R Markdown pour tester le package {aspe} et produire les tutos
• aspe_demo : Fichiers R Markdown pour prétraiter les données pour un tableau de bord interactif
• aspeQual : package R destiné à la mise en qualité de la base Aspe

The package comes with a number of associated repos :

• aspe_data: building of the datasets included in the {aspe} package
• aspe_test: R Markdown files to test the {aspe} package and to build the tutorials
• aspe_demo: R Markdown files to pre-process the fish data for a dashboard app
• aspeQual : R package dedicated to the quality control on the Aspe database

Tutoriels / Vignettes

La documentation générale du package est diffusée sur Github pages : https://pascalirz.github.io/aspe/

Une série de tutoriels est en ligne :

• Traiter des données Indice Poisson Rivière (IPR)
• Faire des traitements de base à partir des lots
• Traiter des mesures individuelles
• Faire des traitements géographiques
• Construire des relations taille-poids

Several vignettes (in French) are available online:

• Processing the fish-based river health index
• Base processing on the fish batches data
• Processing the individual measurements
• Geographical analysis
• Fitting length-weight relationships

Nommage des fonctions / Functions' naming rules

Les familles de fonctions se distinguent par des préfixes :

• mef_ : mise en forme des dataframes
• expl_ : exploration de la base
• export: export des dataframes (.csv ou .RData)
• geo_ : opérations spatiales
• gg_ : production de graphiques avec ggplot2
• imp_ : importation depuis un dump SQL
• ipr_ : indice poisson rivière
• misc_ : divers

Functions' names start by group-specific prefixes:

• mef_: tidying dataframes
• expl_: exploring the database
• export: exporting dataframes (.csv or .RData)
• geo_: spatial processing
• gg_: plots with ggplot2
• imp_: importing data from a SQL dump
• ipr_: fish-based river health index
• misc_: miscellaneous

Nommage des variables / Variables' naming rules

Dans la quasi-totalité des cas, les variables contenues dans une table sont préfixées en fonction de cette table. Par exemple :

• sta_ : station
• pop_ : point_prelevement
• mei_ : mesure_individuelle

Pour une liste des noms et signification des variables, taper dans la console :

data("data_dictionnaire")
View(data_dictionnaire)

Almost systematically, variables' names start by table-specific prefixes:

• sta_ : station
• pop_ : point_prelevement (sampling point)
• mei_ : mesure_individuelle (individual measurment)

To display a comprehensive list of variables with their meaning (all in French so far, sorry), call:

data("data_dictionnaire")
View(data_dictionnaire)