ecofloRe: Fonctions R pour Ecoflore

# Aide associée aux différentes données disponibles dans le package
#
# Auteur: Victor Moinard
# Date de création : 22 juin 2017
###############################################################################


#' @title Base de donnée ecofloRe
#'
#' @description Toutes les tables utiles au calcul ecofloRe
#'
#' @details Ces tables sont issus d'un regroupement et d'une harmonisation de la base
#'  de données access de Michel Bartoli. Ce travail a été réalisé en 2016/2017 par
#'  Victor Moinard. Les tables sont loin d'être parfaites, une évaluation et une
#'  harmonisation plus poussée par des écologues serait nécessaire. Aucune
#'  information de Michel Bartoli n'a été modifié, si ce n'est l'orthographe érroné
#'  de certaines plantes.
#'  Ces données sont utilisé dans les fonctions \link[ecofloRe]{ecofloRe}
#'
#' @name ECOFLORE.data
#' @aliases ECOFLORE.liste ECOFLORE.especes ECOFLORE.essences ECOFLORE.GEI ECOFLORE.abondance ECOFLORE.doc
#' @docType data
#' @format 6 data.frame :
#'  ECOFLORE.liste : 1 ligne par espèce, informations nécessaires à la reconnaissance des espèces rentré par l'utilisateur.
#'  ECOFLORE.especes : 1 ligne par contexte, informations necessaires à l'attribution d'un groupe troph-hydrique à une plante.
#'  ECOFLORE.GEI : 1 ligne par groupe, informations sur les groupes trophydrique
#'  ECOFLORE.abondance : code d'abondance avec leur valeur de pondération respectives
#'  ECOFLORE.essences : informations sur la position des essences dans le diagramme de Rameau
#'  ECOFLORE.doc : informations sur les champs de ces 6 tables
#'
#' @seealso \code{\link[ecofloRe]{ecofloRe}}
#' @references
#' Bartoli et al 2000, Revue Forestière Française
#'
#' Bruno et Bartoli 2001, Revue Forestière Française
#'
#'
#' @family ecofloRe
#' @keywords datasets
#' @examples
#'
#'## Chargement des donnees
#'data("ECOFLORE.data")
#'
#'##informations sur les tables
#'ECOFLORE.doc
#'
#'
NULL

#' @title Exemple de relevés floristiques : Coisia
#'
#' @description Relevés floristiques du site de Coisia (essai cèdres), datant de 2016
#'
#' @details Des relevés floristiques ont été menés sur le site de Coisia (essai Cèdre)
#'  par Didier Bier et Emila Akroume (pôle de Dole), afin de déterminer la différence stationelles sur les placettes.
#'  Les provenances de Cèdres sont : trou, sau, dam, iss, ria, men, ven
#'  Les essais sont répartis sur 2 blocs (1 et 2), avec un témoins extérieur à l'essai (ext).
#'
#' @name ReleveFloreCoisia
#' @docType data
#' @format
#' \describe{
#'  \item{Site}{nom du site}
#'  \item{Releve}{nom de la placette, avec la provenance et le bloc}
#'  \item{Nom_fr_fff}{Nom français de la plante dans la Flore Forestière Française}
#'  \item{Nom_latin_fff}{Nom latin de la plante dans la Flore Forestière Française}
#'  \item{Abondance}{abondance de l'espèce}
#'  \item{Strate}{Information sur la strate}
#' }
#' @seealso \code{\link[ecofloRe]{ecofloRe}}
#'
#' @source Pôle RDI de Dole
#'
#' @family ecofloRe
#' @keywords datasets
#' @examples
#'
#'## Chargement des donnees
#'data("ReleveFloreCoisia")
#'
NULL

#' @title Exemple de relevés floristiques : Chaux
#'
#' @description Relevés floristiques du catalogue de stations de la forêt de Chaux
#'
#' @name ReleveFloreChaux
#' @docType data
#' @format
#' \describe{
#'  \item{Releve}{nom de la station}
#'  \item{Abondance}{abondance de l'espèce}
#'  \item{CD_REF}{Identifiant Taxref de l'espèce}
#'  \item{essence}{booléen, cette espèce est-elle une essence forestière ?}
#'  \item{especes}{nom français de la plante tel qu'écrit dans le relevé floristique du catalogue}
#' }
#'
#' @seealso \code{\link[ecofloRe]{ecofloRe}}
#'
#' @references
#' Bailly, G. 1989 Catalogue des types de stations forestieres du massif de Chaux
#'
#' @source
#' Bailly, G. 1989 Catalogue des types de stations forestieres du massif de Chaux
#'
#' @family ecofloRe
#' @keywords datasets
#' @examples
#'
#'## Chargement des donnees
#'data("ReleveFloreChaux")
#'
NULL