R/fishflux-package.R

In fishflux: Model Elemental Fluxes in Fishes

#' The 'fishflux' package.
#'
#' @description The `r fishflux` package provides a tool to model fluxes of C (carbon), N (nitrogen) and P (phosphorus) in fish.
#' It combines basic priciples from elemental stoichiometry and metabolic theory.
#' The package offers a userfriendly interface to make nutrient dynamic modelling available for anyone.
#' `r fishflux` is mostly targeted towards fish ecologists,
#' wishing to predict nutrient ingestion, egestion and excretion to study fluxes of nutrients and energy.
#' Main assets:
#' \itemize{
#' \item Provides functions to model fluxes of Carbon, Nitrogen and Phosphorus for fish with or without the MCMC sampler provided by stan.
#' \item Provides some tools to find the right parameters as inputs into the model
#' \item Provides a plotting function to illustrate results
#'}
#'
#' @docType package
#' @name fishflux-package
#' @aliases fishflux
#' @useDynLib fishflux, .registration = TRUE
#' @import methods
#' @import Rcpp
#'
#' @references
#' Stan Development Team (2020). RStan: the R interface to Stan. R package version 2.19.3. https://mc-stan.org
#'
NULL