R/xxx_data.R

In pobsteta/gftools: Geographic Data Analysis and Modeling for Forests

# Aide associee aux differentes donnees disponibles dans le package
# Cette aide, volumineuse, est mise a part pour en simplifier la maintenance
# Auteur: Francois Morneau, Pascal Obstetar
# DFRN R&D, Pole de Boigny
# Date de creation : 2 decembre 2014
# Auteur: Pascal Obstetar
# Date de modification : 27 novembre 2017
###############################################################################

#' @title Liste des tarifs employes a l'ONF
#'
#' @description Liste et details des tarifs de la base access de Jean-Marie Michon
#'
#' @name ListTarONF3
#' @docType data
#' @format A data frame with observations on the following 9 variables :
#'   \describe{
#'     \item{id_onf}{Identifiant du tarif. C'est le nom de la fonction a appeler}
#'     \item{ess}{Essence(s) auxquelle(s) s'applique le tarif}
#'     \item{diffuse}{A-t-il ?t? diffuse : oui (\code{O}) ou non (\code{N})}
#'     \item{dom_const}{Domaine geographique de construction du tarif}
#'     \item{date_result}{Date de construction}
#'     \item{TypeVol_tar}{Type de volume produit par le tarif}
#'     \item{DefVol}{Definition du volume produit}
#'     \item{coef_corr}{Coefficient de correlation R obtenu lors de l'ajustement}
#'     \item{diam_echant}{Gamme de diam?tre echantillonnee lors de l'ajustement du tarif}
#'     \item{struct_echant}{Type de structure forestiere pour laquelle le tarif a ete construit}
#'     \item{entr1}{Nom de la premiere entree}
#'     \item{entr2}{Nom de la deuxieme entree, s'il y a lieu}
#' }
#' @source Base de donnees Access 'base-tarif.mdb' d'Hilaire Martin et Jacky
#' Lipovac, repris Jean-Marie Michon
#' @family Tarifs
#' @keywords datasets
#' @examples
#'
#' # Affichage des premieres lignes
#' head(ListTarONF3)
#'
#' # Selection des tarifs  a 1 entree : d130 fournissant le volume VCGB pur le chene
#' subset(ListTarONF3, ess = 'chene' & entr1 == 'd130' & is.na(entr2) & TypeVol_tar == 'VCGB')
#'
#'
NULL

#' ListTarEmerge
#'
#' Liste des tarifs vtige et vtot EMERGE (version 'mai2')
#'
#' La liste complete des tarifs par essence, developpes dans le projet ANR
#' EMERGE. Les tarifs fournissent le 'volume bois fort tige' (d?coupe 7 cm) et le volume
#' total (decoupe 0 cm)
#'
#'
#' @name ListTarEmerge
#' @docType data
#' @format A data frame with 93 observations on the following 15 variables.
#'
#' \describe{
#' \item{nomess}{a factor with levels : le nom d'essence = Genre espece en general depuis \code{Abies alba} a \code{Ulmus sp.}}
#' \item{code_james}{code_james}
#' \item{ESPAR}{code ESPAR IFN}
#' \item{Codeesp}{Codeesp}
#' \item{Tax_ref}{Referentiel taxonomique}
#' \item{nom_fr_ss_accent_minus}{Noms francais sans accent}
#' \item{ess}{a factor with levels : les codes essence du dictionnaire R&D de l'ONF de \code{A.F} a \code{TRE}}
#' \item{feuil_res}{Feuillus/Resineux}
#' \item{grp_ess}{Groupe essence}
#' \item{grp_acm}{a factor with 11 levels : les 11 groupe d'essence issus de l'ACM de \code{A1} a \code{E2}}
#' \item{nb_ifn}{a numeric vector, nombre d'arbres dans les donnees IFN pour l'ajustement de vtige}
#' \item{nb_inra}{a numeric vector, nombre d'arbres dans les donnees INRA pour l'ajustement de vtot}
#' \item{a1}{a numeric vector, premier parametre de la fonction volume total}
#' \item{b1}{a numeric vector, deuxieme parametre de la fonction volume total}
#' \item{c1}{a numeric vector, troisieme parametre de la fonction volume total}
#' \item{a2}{a numeric vector, premier parametre de la fonction volume bois fort tige}
#' \item{b2}{a numeric vector, deuxieme parametre de la fonction volume bois fort tige}
#' \item{c2}{a numeric vector, troisieme parametre de la fonction volume bois fort tige}
#' \item{d2}{a numeric vector, quatrieme parametre de la fonction volume bois fort tige}
#' \item{a3}{a numeric vector, premier parametre de la fonction volume houppier}
#' \item{b3}{a numeric vector, premier parametre de la fonction volume houppier}
#' }
#' @seealso \code{\link{TarEmerge}} la fonction utilisant ces tarifs
#' dico_rd qui contient la liste des codes essences ONF
#' @references Voir rapports de C. Deleuze
#' @source Projet EMERGE ANR-08-BIOE-003
#' @author Christine Deleuze (portage sous R par Francois Morneau)
#' @family Tarifs
#' @keywords datasets
#' @examples
#'
#' str(ListTarEmerge)
#'
NULL

#' Dictionnaire des variables R et D de l'ONF
#'
#' Liste des deux dictionnaires R et D de l'ONF : celui des variables
#' elles-memes et celui de leur modalites (quand il y a lieu)
#'
#' Ces deux dictionnaires contiennent les codifications de variables communes
#' au departement R et D de l'ONF. Ils sont susceptibles d'evoluer dans le temps
#'
#'
#' @name dico_rd
#' @aliases dico_var_rd dico_mod_rd
#' @docType data
#'
#' @format The format is:
#' List of 3 $
#'
#' $date       : chr '23 juin 2014'
#'
#' $dico_var_rd:'data.frame': 72 obs. of 6 variables:
#'
#' ..$ code_dico_rd : chr 'no_mes' 'ann_veg' 'code_pla' 'no_arb' ...
#'
#' ..$ nom : chr 'numero de la mesure' 'annee de vegetation' 'code de la placette ' 'numero de l'arbre' ...
#'
#' ..$ definition : chr 'identifiant de la campagne de mesure' 'annee de vegetation
#' comprise dans la mesure' ...
#'
#' ..$ unite_standard: chr NA NA NA NA ...
#'
#' ..$ protocole : chr  NA NA NA NA ...
#'
#' ..$ obs : chr  NA 'date de differenciation : 30 juin ?' 'code placette = 1 unite experimentale' NA ...
#'
#' $ dico_mod_rd:'data.frame':689 obs. of  4 variables:
#'
#' ..$ code_dico_rd: chr [1:689] 'av_ap' 'av_ap' 'av_ap' 'dep' ...
#'
#' ..$ code_mod_rd : chr [1:689] 'ap' 'av' 'sans' '01' ...
#'
#' ..$ nom         : chr [1:689] 'inventaire apres intervention' 'inventaire avant intervention' 'inventaire en absence d'intervention' 'ain' ...
#'
#' ..$ remarque    : chr [1:689] NA NA NA NA ...
#'
#' @source Extrait direct (les accents en moins) du fichier Excel
#' dico_var_RD.xls' sur le partage du departement
#'
#' @family ONF
#' @keywords datasets
#'
#' @examples
#'
#' str(dico_rd)
#'
NULL

#' @title Liste des coeffcients d'ecorce
#'
#' @description Liste des coeffcients d'ecorce
#'
#' @name Ecorces
#' @docType data
#' @format A tibble with 64 observations on the following 4 variables :
#' \describe{
#' \item{Code_IFN}{Code ESPAR IFN de l'essence}
#' \item{Nom}{Essence(s) auxquelle(s) s'applique les variables a et b}
#' \item{a}{Variable a}
#' \item{b}{Variable b}
#' }
#' @source Base de donnees IFN
#' @family Tarifs
#' @keywords datasets
#' @examples
#'
#' # Affichage des premieres lignes
#' head(Ecorces)
#'
NULL

#' @title Liste de correspondance code essence ONF IFN
#'
#' @description Liste des codes essence ONF/IFN
#'
#' @name code_ifn_onf
#' @docType data
#' @format A tibble with 142 species on the following 4 variables :
#' \describe{
#' \item{code}{Code ESPAR IFN de l'essence}
#' \item{fr}{Regroupement essence auxquelle appartient l'essence}
#' \item{ifn}{Nom essence IFN}
#' \item{onf}{Code essence ONF}
#' }
#' @source Base de donnees IFN et ONF
#' @family Essences
#' @keywords datasets
#' @examples
#'
#' # Affichage des premieres lignes
#' head(code_ifn_onf)
#'
NULL