From 3f4a33bed5c98d1d79876fffab84bc26d717725d Mon Sep 17 00:00:00 2001 From: David Dorchies <14124454+DDorch@users.noreply.github.com> Date: Thu, 22 Feb 2024 14:35:17 +0100 Subject: [PATCH] docs(README): add new endpoints for API Poisson Refs #40 --- README.md | 9 ++++++++- man-roxygen/hubeau.md | 5 ++++- man/hubeau.Rd | 5 ++++- 3 files changed, 16 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 56b513b..b631573 100644 --- a/README.md +++ b/README.md @@ -109,8 +109,15 @@ API documentation: Available function: +- [`get_poisson_operations`](https://inrae.github.io/hubeau/reference/get_poisson.html): + sampling operations carried out at stations measuring the quality of + rivers - [`get_poisson_observations`](https://inrae.github.io/hubeau/reference/get_poisson.html): - scientific fishery observations + fish observations made during sampling operations +- [`get_poisson_indicateurs`](https://inrae.github.io/hubeau/reference/get_poisson.html): + the IPR and IPR+ indicators calculated from fish observations +- [`get_poisson_stations`](https://inrae.github.io/hubeau/reference/get_poisson.html): + stations measuring the quality of rivers ## API “Prélèvements en eau” diff --git a/man-roxygen/hubeau.md b/man-roxygen/hubeau.md index 426223d..1e0ea04 100644 --- a/man-roxygen/hubeau.md +++ b/man-roxygen/hubeau.md @@ -50,7 +50,10 @@ API documentation: Available function: -- [get_poisson_observations()]: scientific fishery observations +- [get_poisson_operations()]: sampling operations carried out at stations measuring the quality of rivers +- [get_poisson_observations()]: fish observations made during sampling operations +- [get_poisson_indicateurs()]: the IPR and IPR+ indicators calculated from fish observations +- [get_poisson_stations()]: stations measuring the quality of rivers ## API "Prélèvements en eau" diff --git a/man/hubeau.Rd b/man/hubeau.Rd index c2d3ad1..59799cd 100644 --- a/man/hubeau.Rd +++ b/man/hubeau.Rd @@ -63,7 +63,10 @@ API documentation: \url{https://hubeau.eaufrance.fr/page/api-poisson} Available function: \itemize{ -\item \code{\link[=get_poisson_observations]{get_poisson_observations()}}: scientific fishery observations +\item \code{\link[=get_poisson_operations]{get_poisson_operations()}}: sampling operations carried out at stations measuring the quality of rivers +\item \code{\link[=get_poisson_observations]{get_poisson_observations()}}: fish observations made during sampling operations +\item \code{\link[=get_poisson_indicateurs]{get_poisson_indicateurs()}}: the IPR and IPR+ indicators calculated from fish observations +\item \code{\link[=get_poisson_stations]{get_poisson_stations()}}: stations measuring the quality of rivers } }