[Stacomir-commits] r604 - in pkg/stacomir: . man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Sun Nov 14 20:52:02 CET 2021
Author: briand
Date: 2021-11-14 20:52:02 +0100 (Sun, 14 Nov 2021)
New Revision: 604
Added:
pkg/stacomir/man/fun_dailystats.Rd
Removed:
pkg/stacomir/man/funstat_daily.Rd
pkg/stacomir/man/get_org.Rd
pkg/stacomir/man/get_schema.Rd
Modified:
pkg/stacomir/DESCRIPTION
pkg/stacomir/NAMESPACE
pkg/stacomir/man/calcule-report_ge_weight-method.Rd
pkg/stacomir/man/charge-ref_list-method.Rd
pkg/stacomir/man/charge-ref_par-method.Rd
pkg/stacomir/man/charge-report_species-method.Rd
pkg/stacomir/man/charge_complement-ref_parqual-method.Rd
pkg/stacomir/man/charge_with_filter-ref_par-method.Rd
pkg/stacomir/man/charge_with_filter-ref_parqual-method.Rd
pkg/stacomir/man/charge_with_filter-ref_parquan-method.Rd
pkg/stacomir/man/charge_with_filter-ref_stage-method.Rd
pkg/stacomir/man/charge_with_filter-ref_taxa-method.Rd
pkg/stacomir/man/choice_c-ref_horodate-method.Rd
pkg/stacomir/man/choice_c-ref_list-method.Rd
pkg/stacomir/man/choice_c-ref_par-method.Rd
pkg/stacomir/man/connect-report_ge_weight-method.Rd
pkg/stacomir/man/plot-report_ge_weight-missing-method.Rd
pkg/stacomir/man/r_mig_interannual.Rd
pkg/stacomir/man/r_mig_mult_dc.Rd
pkg/stacomir/man/ref_dc-class.Rd
pkg/stacomir/man/ref_df-class.Rd
pkg/stacomir/man/ref_year-class.Rd
Log:
document
Modified: pkg/stacomir/DESCRIPTION
===================================================================
--- pkg/stacomir/DESCRIPTION 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/DESCRIPTION 2021-11-14 19:52:02 UTC (rev 604)
@@ -20,6 +20,7 @@
Collate:
'create_generic.R'
'data.R'
+ 'fun_dailystats.R'
'fun_table_per_dis.R'
'fun_write_monthly.R'
'fungraph.R'
Modified: pkg/stacomir/NAMESPACE
===================================================================
--- pkg/stacomir/NAMESPACE 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/NAMESPACE 2021-11-14 19:52:02 UTC (rev 604)
@@ -6,6 +6,7 @@
export(charge_with_filter)
export(choice_c)
export(colortable)
+export(createmessage)
export(envir_stacomi)
export(fun_aggreg_for_plot)
export(fun_date_extraction)
@@ -47,7 +48,7 @@
exportMethods(write_database)
exportMethods(xtable)
import(RColorBrewer)
-import(RPostgres)
+import(RPostgreSQL)
import(ggplot2)
import(methods)
import(stacomirtools)
Modified: pkg/stacomir/man/calcule-report_ge_weight-method.Rd
===================================================================
--- pkg/stacomir/man/calcule-report_ge_weight-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/calcule-report_ge_weight-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -3,7 +3,7 @@
\name{calcule,report_ge_weight-method}
\alias{calcule,report_ge_weight-method}
\alias{calcule.report_ge_weight}
-\title{Calcule method for report_ge_weight}
+\title{Internal handler for reg, class \code{\link{report_ge_weight-class}}.}
\usage{
\S4method{calcule}{report_ge_weight}(object, silent = FALSE)
}
@@ -11,10 +11,19 @@
\item{object}{An object of class \code{\link{report_ge_weight-class}}}
\item{silent}{Boolean, if TRUE, information messages are not displayed, only warnings and errors}
+
+\item{h}{handler}
+
+\item{\dots}{additional arguments passed to the function}
}
\description{
-Calcule method for report_ge_weight
+Internal handler for reg, class \code{\link{report_ge_weight-class}}.
}
\author{
Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
}
+\keyword{Calcule}
+\keyword{for}
+\keyword{internal}
+\keyword{method}
+\keyword{report_ge_weight}
Modified: pkg/stacomir/man/charge-ref_list-method.Rd
===================================================================
--- pkg/stacomir/man/charge-ref_list-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge-ref_list-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -2,8 +2,7 @@
% Please edit documentation in R/ref_list.R
\name{charge,ref_list-method}
\alias{charge,ref_list-method}
-\alias{charge.ref_list}
-\title{Loading method for ref_list referential objects}
+\title{Loading method for refliste referential objects}
\usage{
\S4method{charge}{ref_list}(object, listechoice, label)
}
@@ -18,7 +17,7 @@
An object of class ref_list
}
\description{
-Loading method for ref_list referential objects
+Loading method for refliste referential objects
}
\examples{
\dontrun{
Modified: pkg/stacomir/man/charge-ref_par-method.Rd
===================================================================
--- pkg/stacomir/man/charge-ref_par-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge-ref_par-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -2,8 +2,7 @@
% Please edit documentation in R/ref_par.R
\name{charge,ref_par-method}
\alias{charge,ref_par-method}
-\alias{charge.ref_par}
-\title{Loading method for ref_par referential objects}
+\title{Loading method for Repar referential objects}
\usage{
\S4method{charge}{ref_par}(object)
}
@@ -14,7 +13,7 @@
An S4 object of class ref_par
}
\description{
-Loading method for ref_par referential objects
+Loading method for Repar referential objects
}
\examples{
\dontrun{
Modified: pkg/stacomir/man/charge-report_species-method.Rd
===================================================================
--- pkg/stacomir/man/charge-report_species-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge-report_species-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -3,7 +3,7 @@
\name{charge,report_species-method}
\alias{charge,report_species-method}
\alias{charge.report_species}
-\title{charge method for report_species}
+\title{handler for calculation}
\usage{
\S4method{charge}{report_species}(object, silent = FALSE)
}
@@ -11,15 +11,44 @@
\item{object}{An object of class \link{report_species-class}}
\item{silent}{Stops displaying the messages.}
+
+\item{h}{a handler}
+
+\item{...}{Additional parameters}
}
\value{
report_species with slots filled by user choice
}
\description{
-Verifies the content of objects when the graphical interface is used, it is not necessary
-to call the charge method if the choice_c method has been used
+internal use
}
\author{
Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
+
+Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
}
+\keyword{Verifies}
+\keyword{been}
+\keyword{call}
+\keyword{charge}
+\keyword{choice_c}
+\keyword{content}
+\keyword{for}
+\keyword{graphical}
+\keyword{has}
+\keyword{if}
+\keyword{interface}
\keyword{internal}
+\keyword{is}
+\keyword{it}
+\keyword{method}
+\keyword{necessary}
+\keyword{not}
+\keyword{objects}
+\keyword{of}
+\keyword{report_species}
+\keyword{the}
+\keyword{to}
+\keyword{used}
+\keyword{used,}
+\keyword{when}
Modified: pkg/stacomir/man/charge_complement-ref_parqual-method.Rd
===================================================================
--- pkg/stacomir/man/charge_complement-ref_parqual-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge_complement-ref_parqual-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -19,9 +19,9 @@
}
\examples{
\dontrun{
- dc_selected=6
-taxa_selected=2038
- stage_selected='AGJ'
+ dc_selectionne=6
+taxa_selectionne=2038
+ stage_selectionne='AGJ'
object=new('ref_parqual')
object<-charge(object)
charge_complement(object)
Modified: pkg/stacomir/man/charge_with_filter-ref_par-method.Rd
===================================================================
--- pkg/stacomir/man/charge_with_filter-ref_par-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge_with_filter-ref_par-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -2,30 +2,29 @@
% Please edit documentation in R/ref_par.R
\name{charge_with_filter,ref_par-method}
\alias{charge_with_filter,ref_par-method}
-\alias{charge_with_filter.ref_par}
-\title{Loading method for \code{ref_par referential} objects searching only those parameters existing for a DC, a Taxa, and a stage}
+\title{Loading method for Repar referential objects searching only those parameters existing for a DC, a Taxa, and a stage}
\usage{
-\S4method{charge_with_filter}{ref_par}(object, dc_selected, taxa_selected, stage_selected)
+\S4method{charge_with_filter}{ref_par}(object, dc_selectionne, taxa_selectionne, stage_selectionne)
}
\arguments{
\item{object}{An object of class \link{ref_par-class}}
-\item{dc_selected}{A counting device selected for the report}
+\item{dc_selectionne}{A counting device selected for the report}
-\item{taxa_selected}{The taxa selected for the report}
+\item{taxa_selectionne}{The taxa selected for the report}
-\item{stage_selected}{The stage selected for the report}
+\item{stage_selectionne}{The stage selected for the report}
}
\value{
An S4 object of class ref_par
}
\description{
-Loading method for \code{ref_par referential} objects searching only those parameters existing for a DC, a Taxa, and a stage
+Loading method for Repar referential objects searching only those parameters existing for a DC, a Taxa, and a stage
}
\examples{
\dontrun{
object=new('ref_par')
-charge_with_filter(object,dc_selected=6,taxa_selected=2038,stage_selected=c('AGJ','CIV')
+charge_with_filter(object,dc_selectionne=6,taxa_selectionne=2038,stage_selectionne=c('AGJ','CIV')
}
}
\author{
Modified: pkg/stacomir/man/charge_with_filter-ref_parqual-method.Rd
===================================================================
--- pkg/stacomir/man/charge_with_filter-ref_parqual-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge_with_filter-ref_parqual-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -4,16 +4,16 @@
\alias{charge_with_filter,ref_parqual-method}
\title{Loading method for Reparqual referential objects searching only those parameters existing for a DC, a Taxon, and a stage}
\usage{
-\S4method{charge_with_filter}{ref_parqual}(object, dc_selected, taxa_selected, stage_selected)
+\S4method{charge_with_filter}{ref_parqual}(object, dc_selectionne, taxa_selectionne, stage_selectionne)
}
\arguments{
\item{object}{An object of class \link{ref_parqual-class}}
-\item{dc_selected}{The dc set in the report object}
+\item{dc_selectionne}{The dc set in the report object}
-\item{taxa_selected}{The taxa set in the report object}
+\item{taxa_selectionne}{The taxa set in the report object}
-\item{stage_selected}{The stage set in the report object}
+\item{stage_selectionne}{The stage set in the report object}
}
\value{
An S4 object of class \link{ref_parqual-class}
@@ -23,11 +23,11 @@
}
\examples{
\dontrun{
- dc_selected=6
- taxa_selected=2038
- stage_selected='AGJ'
+ dc_selectionne=6
+ taxa_selectionne=2038
+ stage_selectionne='AGJ'
object=new('ref_parqual')
- charge_with_filter(object,dc_selected,taxa_selected,stage_selected)
+ charge_with_filter(object,dc_selectionne,taxa_selectionne,stage_selectionne)
}
}
\author{
Modified: pkg/stacomir/man/charge_with_filter-ref_parquan-method.Rd
===================================================================
--- pkg/stacomir/man/charge_with_filter-ref_parquan-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge_with_filter-ref_parquan-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -4,16 +4,16 @@
\alias{charge_with_filter,ref_parquan-method}
\title{Loading method for Reparquan referential objects searching only those parameters existing for a DC, a Taxon, and a stage}
\usage{
-\S4method{charge_with_filter}{ref_parquan}(object, dc_selected, taxa_selected, stage_selected)
+\S4method{charge_with_filter}{ref_parquan}(object, dc_selectionne, taxa_selectionne, stage_selectionne)
}
\arguments{
\item{object}{An object of class \link{ref_parquan-class}}
-\item{dc_selected}{The dc set in the report object}
+\item{dc_selectionne}{The dc set in the report object}
-\item{taxa_selected}{The taxa set in the report object}
+\item{taxa_selectionne}{The taxa set in the report object}
-\item{stage_selected}{The stage set in the report object}
+\item{stage_selectionne}{The stage set in the report object}
}
\value{
An S4 object of class ref_parqualn
@@ -23,11 +23,11 @@
}
\examples{
\dontrun{
- dc_selected=6
-taxa_selected=2038
- stage_selected='AGJ'
+ dc_selectionne=6
+taxa_selectionne=2038
+ stage_selectionne='AGJ'
object=new('ref_parquan')
- charge_with_filter(object,dc_selected,taxa_selected,stage_selected)
+ charge_with_filter(object,dc_selectionne,taxa_selectionne,stage_selectionne)
}
}
\author{
Modified: pkg/stacomir/man/charge_with_filter-ref_stage-method.Rd
===================================================================
--- pkg/stacomir/man/charge_with_filter-ref_stage-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge_with_filter-ref_stage-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -4,14 +4,14 @@
\alias{charge_with_filter,ref_stage-method}
\title{Loading method for ref_stage referential objects searching only those stages existing for a DC and a Taxon}
\usage{
-\S4method{charge_with_filter}{ref_stage}(object, dc_selected, taxa_selected)
+\S4method{charge_with_filter}{ref_stage}(object, dc_selectionne, taxa_selectionne)
}
\arguments{
\item{object}{An object of class \link{ref_stage-class}}
-\item{dc_selected}{The selected counting device}
+\item{dc_selectionne}{The selected counting device}
-\item{taxa_selected}{The selected species}
+\item{taxa_selectionne}{The selected species}
}
\value{
An S4 object of class \link{ref_stage-class}
@@ -21,10 +21,10 @@
}
\examples{
\dontrun{
- dc_selected=6
-taxa_selected=2038
+ dc_selectionne=6
+taxa_selectionne=2038
object=new('ref_stage')
- charge_with_filter(object,dc_selected,taxa_selected)
+ charge_with_filter(object,dc_selectionne,taxa_selectionne)
}
}
\author{
Modified: pkg/stacomir/man/charge_with_filter-ref_taxa-method.Rd
===================================================================
--- pkg/stacomir/man/charge_with_filter-ref_taxa-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/charge_with_filter-ref_taxa-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -4,12 +4,12 @@
\alias{charge_with_filter,ref_taxa-method}
\title{Loading method for ref_taxa referential objects searching only taxa existing for a DC}
\usage{
-\S4method{charge_with_filter}{ref_taxa}(object, dc_selected)
+\S4method{charge_with_filter}{ref_taxa}(object, dc_selectionne)
}
\arguments{
\item{object}{An object of class \link{ref_taxa-class}}
-\item{dc_selected}{A counting device selected, only taxa attached to this dc are selected}
+\item{dc_selectionne}{A counting device selected, only taxa attached to this dc are selected}
}
\value{
An S4 object of class ref_taxa
@@ -19,9 +19,9 @@
}
\examples{
\dontrun{
- dc_selected=6
+ dc_selectionne=6
object=new('ref_taxa')
- charge_with_filter(object,dc_selected=dc_selected)}
+ charge_with_filter(object,dc_selectionne=dc_selectionne)}
}
\author{
Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
Modified: pkg/stacomir/man/choice_c-ref_horodate-method.Rd
===================================================================
--- pkg/stacomir/man/choice_c-ref_horodate-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/choice_c-ref_horodate-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -2,8 +2,7 @@
% Please edit documentation in R/ref_horodate.R
\name{choice_c,ref_horodate-method}
\alias{choice_c,ref_horodate-method}
-\alias{choice_c.ref_horodate}
-\title{Choice_c method for ref_horodate}
+\title{Graphical interface}
\usage{
\S4method{choice_c}{ref_horodate}(
object,
@@ -25,11 +24,19 @@
\dots are accepted. The choice_c method assigns and}
\item{silent}{Default FALSE, should messages be displayed}
+
+\item{label}{Label for the gframe}
+
+\item{decal}{Default 0, number of years to shift forward or backward}
}
\value{
+Selects the date in the graphical interface, and assigns an object of class POSIXt with name nomassign in envir_stacomi
+Command line
+
An object of class \link{ref_horodate-class} with slot \emph{horodate} set,
and assigns an object of class POSIXt with name nomassign in envir_stacomi
}
\description{
-Choice_c method for ref_horodate
+Graphical interface
}
+\keyword{internal}
Modified: pkg/stacomir/man/choice_c-ref_list-method.Rd
===================================================================
--- pkg/stacomir/man/choice_c-ref_list-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/choice_c-ref_list-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -2,8 +2,7 @@
% Please edit documentation in R/ref_list.R
\name{choice_c,ref_list-method}
\alias{choice_c,ref_list-method}
-\alias{choice_c.ref_list}
-\title{Choice_c method for ref_list referential objects}
+\title{Choice method for ref_list referential objects}
\usage{
\S4method{choice_c}{ref_list}(object, selectedvalue)
}
@@ -11,16 +10,28 @@
\item{object}{An object of class \link{ref_list-class}}
\item{selectedvalue}{the value selected in the combo}
+
+\item{is.enabled}{A boolean indicating whether the frame is enabled when first displayed, default to TRUE}
}
\description{
-Choice_c method for ref_list referential objects
+Choice method for ref_list referential objects
}
\note{
the choice method assigns an object of class refList named ref_list in the environment envir_stacomi
+
+the choice method assigns an object of class refList named ref_list in the environment envir_stacomi
}
\examples{
\dontrun{
+ object=new('ref_list')
+win=gwindow()
+group=ggroup(container=win,horizontal=FALSE)
+object<-charge(object,vecteur=c('choice1','choice2'),label='please choose')
+choice(object)
+}
+
+\dontrun{
object=new('ref_list')
object<-charge(object,vecteur=c('1','2'),label='please choose')
object<-choice_c(object)
@@ -28,4 +39,13 @@
}
\author{
Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
+
+Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
}
+\keyword{Choice_c}
+\keyword{for}
+\keyword{internal}
+\keyword{method}
+\keyword{objects}
+\keyword{ref_list}
+\keyword{referential}
Modified: pkg/stacomir/man/choice_c-ref_par-method.Rd
===================================================================
--- pkg/stacomir/man/choice_c-ref_par-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/choice_c-ref_par-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -2,7 +2,6 @@
% Please edit documentation in R/ref_par.R
\name{choice_c,ref_par-method}
\alias{choice_c,ref_par-method}
-\alias{choice_c.ref_par}
\title{Command line interface to select a parameter}
\usage{
\S4method{choice_c}{ref_par}(object, par, silent = FALSE)
Modified: pkg/stacomir/man/connect-report_ge_weight-method.Rd
===================================================================
--- pkg/stacomir/man/connect-report_ge_weight-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/connect-report_ge_weight-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -5,12 +5,10 @@
\alias{connect.report_ge_weight}
\title{connect method for report_Poids_moyen}
\usage{
-\S4method{connect}{report_ge_weight}(object, silent = TRUE)
+\S4method{connect}{report_ge_weight}(object)
}
\arguments{
\item{object}{An object of class \link{report_ge_weight-class}}
-
-\item{silent}{Should the method be silent}
}
\value{
report_Poids_Moyen request corresponding to user choices, mean weight
Added: pkg/stacomir/man/fun_dailystats.Rd
===================================================================
--- pkg/stacomir/man/fun_dailystats.Rd (rev 0)
+++ pkg/stacomir/man/fun_dailystats.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -0,0 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/fun_dailystats.R
+\name{fun_dailystats}
+\alias{fun_dailystats}
+\title{function to create daily statistics}
+\usage{
+fun_dailystats(tableau, time.sequence, taxa, stage, DC)
+}
+\arguments{
+\item{tableau}{A table}
+
+\item{time.sequence}{Time sequence from report_mig and report_mig_mult}
+
+\item{taxa}{A taxa}
+
+\item{stage}{A stage}
+
+\item{DC}{A counting device}
+}
+\description{
+function to create daily statistics
+}
+\note{
+to be used in shiny
+}
+\author{
+Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
+}
Deleted: pkg/stacomir/man/funstat_daily.Rd
===================================================================
--- pkg/stacomir/man/funstat_daily.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/funstat_daily.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -1,25 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/funstat_daily.R
-\name{funstat_daily}
-\alias{funstat_daily}
-\title{function to create daily statistics}
-\usage{
-funstat_daily(tableau, time.sequence, taxa, stage, DC)
-}
-\arguments{
-\item{tableau}{A table}
-
-\item{time.sequence}{Time sequence from report_mig and report_mig_mult}
-
-\item{taxa}{A taxa}
-
-\item{stage}{A stage}
-
-\item{DC}{A counting device}
-}
-\description{
-function to create daily statistics
-}
-\author{
-Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
-}
Deleted: pkg/stacomir/man/get_org.Rd
===================================================================
--- pkg/stacomir/man/get_org.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/get_org.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -1,18 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/utilities.R
-\name{get_org}
-\alias{get_org}
-\title{this function gets the name of the stucture as it is set in the database}
-\usage{
-get_org()
-}
-\value{
-The name of the structure (org_code)
-}
-\description{
-this function gets the name of the stucture as it is set in the database
-}
-\author{
-Cedric Briand \email{cedric.briand"at"eptb-vilaine.fr}
-}
-\keyword{internal}
Deleted: pkg/stacomir/man/get_schema.Rd
===================================================================
--- pkg/stacomir/man/get_schema.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/get_schema.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -1,21 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/utilities.R
-\name{get_schema}
-\alias{get_schema}
-\title{this function gets the schema from envir stacomi and throws warning}
-\usage{
-get_schema(default = NULL)
-}
-\arguments{
-\item{default}{passed to rlang::get_env}
-}
-\value{
-sch The schema in envir_stacomi
-}
-\description{
-this function gets the schema from envir stacomi and throws warning
-}
-\author{
-Cedric Briand \email{cedric.briand"at"eptb-vilaine.fr}
-}
-\keyword{internal}
Modified: pkg/stacomir/man/plot-report_ge_weight-missing-method.Rd
===================================================================
--- pkg/stacomir/man/plot-report_ge_weight-missing-method.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/plot-report_ge_weight-missing-method.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -3,7 +3,7 @@
\name{plot,report_ge_weight,missing-method}
\alias{plot,report_ge_weight,missing-method}
\alias{plot.report_ge_weight}
-\title{Plot method for report_ge_weight'}
+\title{Internal handler for reg, class \code{\link{report_ge_weight-class}}.}
\usage{
\S4method{plot}{report_ge_weight,missing}(x, plot.type = 1, silent = FALSE)
}
@@ -15,9 +15,13 @@
'3' same as '1' but with size according to number.}
\item{silent}{Stops displaying the messages.}
+
+\item{h}{handler}
+
+\item{\dots}{additional arguments passed to the function}
}
\description{
-Plot method for report_ge_weight'
+Internal handler for reg, class \code{\link{report_ge_weight-class}}.
}
\note{
the model method provides plots for the fitted models
@@ -25,3 +29,8 @@
\author{
Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
}
+\keyword{Plot}
+\keyword{for}
+\keyword{internal}
+\keyword{method}
+\keyword{report_ge_weight'}
Modified: pkg/stacomir/man/r_mig_interannual.Rd
===================================================================
--- pkg/stacomir/man/r_mig_interannual.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/r_mig_interannual.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -16,7 +16,6 @@
operational at the same location and provides one of the longest series of eel migration.
For this reason,
the dataset has been loaded as an example for the report_mig_interannual-class. It has been
-kindly provided by the parc du Marais Poitevin. The stage corresponds to small eels (elvers)
-less than 150 mmm stage name 'PANG'
+kindly provided by the parc du Marais Poitevin.
}
\keyword{data}
Modified: pkg/stacomir/man/r_mig_mult_dc.Rd
===================================================================
--- pkg/stacomir/man/r_mig_mult_dc.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/r_mig_mult_dc.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -24,7 +24,7 @@
}
\item{dc}{the \code{ref_dc} the DC with 4 slots
\describe{
- \item{dc_selected}{the selected device}
+ \item{dc_selectionne}{the selected device}
\item{ouvrage}{the dam}
\item{station}{the monitoring station, a section of river}
\item{data}{A dataset of all dc present in the database with 10 observations}
Modified: pkg/stacomir/man/ref_dc-class.Rd
===================================================================
--- pkg/stacomir/man/ref_dc-class.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/ref_dc-class.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -10,7 +10,7 @@
\section{Slots}{
\describe{
-\item{\code{dc_selected}}{Object of class \code{'integer'}, The selected device}
+\item{\code{dc_selectionne}}{Object of class \code{'integer'}, The selected device}
\item{\code{ouvrage}}{Object of class \code{'integer'}, the attached dam}
@@ -22,7 +22,7 @@
\section{Objects from the Class}{
Objects can be created by calls of the form
-\code{new('ref_dc', dc_selected=integer(), ouvrage=integer(),
+\code{new('ref_dc', dc_selectionne=integer(), ouvrage=integer(),
data=data.frame())}.
}
Modified: pkg/stacomir/man/ref_df-class.Rd
===================================================================
--- pkg/stacomir/man/ref_df-class.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/ref_df-class.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -5,7 +5,7 @@
\alias{ref_df-class}
\title{Class 'ref_df'}
\arguments{
-\item{df_selected}{Object of class \code{'integer'} The identifier of the fishway}
+\item{df_selectionne}{Object of class \code{'integer'} The identifier of the fishway}
\item{ouvrage}{Object of class \code{'integer'} The attached dam}
@@ -15,7 +15,7 @@
Representation of a fishway, contains description data of all fishways from
the database along with the selected fishways (df) (integer)
Objects from the Class: Objects can be created by calls of the form
-\code{new('ref_df', df_selected=integer(), ouvrage=integer(),
+\code{new('ref_df', df_selectionne=integer(), ouvrage=integer(),
data=data.frame())}.
}
\seealso{
Modified: pkg/stacomir/man/ref_year-class.Rd
===================================================================
--- pkg/stacomir/man/ref_year-class.Rd 2021-11-14 19:46:57 UTC (rev 603)
+++ pkg/stacomir/man/ref_year-class.Rd 2021-11-14 19:52:02 UTC (rev 604)
@@ -12,12 +12,12 @@
\describe{
\item{\code{data}}{A \code{data.frame} with the list of possible years selected as numerics}
-\item{\code{selected_year}}{A numeric vector}
+\item{\code{annee_selectionnee}}{A numeric vector}
}}
\section{Objects from the Class}{
Objects can be created by calls of the form
-\code{new("ref_year", data=data.frame(), selected_year=numeric())}.
+\code{new("ref_year", data=data.frame(), annee_selectionnee=numeric())}.
}
\seealso{
More information about the Stacomir-commits
mailing list