[Stacomir-commits] r202 - pkg/stacomir/man
noreply at r-forge.r-project.org
noreply at r-forge.r-project.org
Fri Sep 9 19:53:04 CEST 2016
Author: briand
Date: 2016-09-09 19:53:04 +0200 (Fri, 09 Sep 2016)
New Revision: 202
Added:
pkg/stacomir/man/choice_c-BilanFonctionnementDF-method.Rd
pkg/stacomir/man/hbilanMigrationConditionEnvgraph.Rd
pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle.Rd
pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle2.Rd
pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle3.Rd
pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle4.Rd
pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle5.Rd
pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle7.Rd
pkg/stacomir/man/htableBilanMigrationInterAnnuelle.Rd
Modified:
pkg/stacomir/man/charge-RefStades-method.Rd
pkg/stacomir/man/charge_avec_filtre-RefStades-method.Rd
pkg/stacomir/man/chargecsv.Rd
pkg/stacomir/man/choice-RefStades-method.Rd
pkg/stacomir/man/choice_c-RefStades-method.Rd
pkg/stacomir/man/choicemult-RefStades-method.Rd
pkg/stacomir/man/choicemult-RefTaxon-method.Rd
pkg/stacomir/man/connect-BilanMigration-method.Rd
pkg/stacomir/man/fn_table_per_dis.Rd
pkg/stacomir/man/fntablestade.Rd
pkg/stacomir/man/fun_bilanMigrationMult.Rd
pkg/stacomir/man/funbarchartDF.Rd
pkg/stacomir/man/funboxDF.Rd
pkg/stacomir/man/funcalcbilan_stades_pigm.Rd
pkg/stacomir/man/fundat.Rd
pkg/stacomir/man/fungraphgg.Rd
pkg/stacomir/man/funtableDC.Rd
pkg/stacomir/man/funtableDF.Rd
pkg/stacomir/man/getvalue-Refperiode-method.Rd
pkg/stacomir/man/hBilanConditionEnv.Rd
pkg/stacomir/man/hBilanEspeces.Rd
pkg/stacomir/man/hBilanMigration.Rd
pkg/stacomir/man/hBilanMigrationConditionEnv.Rd
pkg/stacomir/man/hBilanMigrationInterAnnuelle.Rd
pkg/stacomir/man/hBilanMigrationMult.Rd
pkg/stacomir/man/hBilanMigrationPar.Rd
pkg/stacomir/man/hBilan_carlot.Rd
pkg/stacomir/man/hCamembert.Rd
pkg/stacomir/man/hDC.Rd
pkg/stacomir/man/hDF.Rd
pkg/stacomir/man/hDFDC.Rd
pkg/stacomir/man/hOPE.Rd
pkg/stacomir/man/hSt.Rd
pkg/stacomir/man/hTail.Rd
pkg/stacomir/man/hbilanMigrationParcalc.Rd
pkg/stacomir/man/hbilanMigrationPargraph.Rd
pkg/stacomir/man/hbilanMigrationPargraph2.Rd
pkg/stacomir/man/hbilanMigrationParstat.Rd
pkg/stacomir/man/hfungraphstades.Rd
pkg/stacomir/man/hpds.Rd
pkg/stacomir/man/htodo.Rd
pkg/stacomir/man/plot-BilanMigration-ANY-method.Rd
pkg/stacomir/man/plot-BilanMigrationMult-ANY-method.Rd
pkg/stacomir/man/plot-BilanMigrationPar-ANY-method.Rd
pkg/stacomir/man/plot.Rd
pkg/stacomir/man/setRefHorodate-RefHorodate-method.Rd
Log:
Modified: pkg/stacomir/man/charge-RefStades-method.Rd
===================================================================
--- pkg/stacomir/man/charge-RefStades-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/charge-RefStades-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,6 +7,9 @@
\usage{
\S4method{charge}{RefStades}(object)
}
+\arguments{
+\item{object}{An object of class \link{RefStades-class}}
+}
\value{
An S4 object of class RefStades
}
Modified: pkg/stacomir/man/charge_avec_filtre-RefStades-method.Rd
===================================================================
--- pkg/stacomir/man/charge_avec_filtre-RefStades-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/charge_avec_filtre-RefStades-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -8,8 +8,15 @@
\S4method{charge_avec_filtre}{RefStades}(object, dc_selectionne,
taxon_selectionne)
}
+\arguments{
+\item{object}{An object of class \link{RefStades-class}}
+
+\item{dc_selectionne}{The selected counting device}
+
+\item{taxon_selectionne}{The selected species}
+}
\value{
-An S4 object of class RefStades
+An S4 object of class \link{RefStades-class}
}
\description{
Loading method for RefStades referential objects searching only those stages existing for a DC and a Taxon
Modified: pkg/stacomir/man/chargecsv.Rd
===================================================================
--- pkg/stacomir/man/chargecsv.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/chargecsv.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -5,8 +5,12 @@
\title{chargecsv loads the informations stored in c:/program
files/stacomi/calcmig.csv file}
\usage{
-chargecsv()
+chargecsv(database_expected)
}
+\arguments{
+\item{database}{expected Are the program (stacomi directory) and database expected to be installed,
+this argument is necessary to pass tests on system where stacomi is not installed (e.g. R-forge)}
+}
\value{
a list with the datawd place and the baseODBC vector
}
@@ -16,7 +20,7 @@
\code{uid}, \code{pwd} are identifier and password to connect to the database, they should
correspond to your own schema in the database. \code{pgwd} is the path to the R
source if you plan not to use the compiler but run manually using inst/config/stacomi_manual_launch.R for development.\cr
- \code{datawd}, is the the
+\code{datawd}, is the
directory where you want to place the outputs, mostly tables, from the
program, default to ~//CalcmigData lang, is either one of French, English or
Spanish
Modified: pkg/stacomir/man/choice-RefStades-method.Rd
===================================================================
--- pkg/stacomir/man/choice-RefStades-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/choice-RefStades-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,6 +7,13 @@
\usage{
\S4method{choice}{RefStades}(object, objectBilan = NULL, is.enabled = TRUE)
}
+\arguments{
+\item{object}{An object of class \link{RefStades-class}}
+
+\item{objectBilan}{An object Bilan which includes the \link{RefStades-class}, default NULL}
+
+\item{is.enabled}{Sets if the frame is enabled at launch, defaut TRUE}
+}
\description{
Choice method for RefStades referential objects
}
Added: pkg/stacomir/man/choice_c-BilanFonctionnementDF-method.Rd
===================================================================
--- pkg/stacomir/man/choice_c-BilanFonctionnementDF-method.Rd (rev 0)
+++ pkg/stacomir/man/choice_c-BilanFonctionnementDF-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,28 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanFonctionnementDF.r
+\docType{methods}
+\name{choice_c,BilanFonctionnementDF-method}
+\alias{choice_c,BilanFonctionnementDF-method}
+\title{command line interface for BilanFonctionnementDF class}
+\usage{
+\S4method{choice_c}{BilanFonctionnementDF}(object, horodatedebut, horodatefin,
+ ...)
+}
+\arguments{
+\item{object}{An object of class \link{RefDC-class}}
+
+\item{horodatedebut}{A POSIXt or Date or character to fix the date of beginning of the Bilan}
+
+\item{horodatefin}{A POSIXt or Date or character to fix the last date of the Bilan}
+}
+\value{
+An object of class \link{RefDC-class} with slots filled
+}
+\description{
+The choice_c method fills in the data slot for RefDC, and then
+uses the choice_c methods of these object to "select" the data.
+}
+\author{
+Cedric Briand \email{cedric.briand"at"eptb-vilaine.fr}
+}
+
Modified: pkg/stacomir/man/choice_c-RefStades-method.Rd
===================================================================
--- pkg/stacomir/man/choice_c-RefStades-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/choice_c-RefStades-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -8,6 +8,8 @@
\S4method{choice_c}{RefStades}(object, stades)
}
\arguments{
+\item{object}{An object of class \link{RefStades-class}}
+
\item{stades}{the vector of stages chosen}
}
\description{
Modified: pkg/stacomir/man/choicemult-RefStades-method.Rd
===================================================================
--- pkg/stacomir/man/choicemult-RefStades-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/choicemult-RefStades-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -8,6 +8,13 @@
\S4method{choicemult}{RefStades}(object, objectBilan = NULL,
is.enabled = TRUE)
}
+\arguments{
+\item{object}{An object of class \link{RefStades-class}}
+
+\item{objectBilan}{An object Bilan which includes the \link{RefStades-class}, default NULL}
+
+\item{is.enabled}{Sets if the frame is enabled at launch, defaut TRUE}
+}
\description{
Multiple Choice method for RefStades referential objects
}
Modified: pkg/stacomir/man/choicemult-RefTaxon-method.Rd
===================================================================
--- pkg/stacomir/man/choicemult-RefTaxon-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/choicemult-RefTaxon-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -9,6 +9,13 @@
\S4method{choicemult}{RefTaxon}(object, objectBilan = NULL,
is.enabled = TRUE)
}
+\arguments{
+\item{object}{An object of class \link{RefTaxon-class}}
+
+\item{objectBilan}{An object Bilan which includes the \link{RefTaxon-class}, default NULL}
+
+\item{is.enabled}{Sets if the frame is enabled at launch, defaut TRUE}
+}
\description{
Multiple Choice method for Reftaxon referential objects, the graphical interface is built to allow
for multiple choices. See load for method in the command line.
Modified: pkg/stacomir/man/connect-BilanMigration-method.Rd
===================================================================
--- pkg/stacomir/man/connect-BilanMigration-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/connect-BilanMigration-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -5,7 +5,7 @@
\alias{connect,BilanMigration-method}
\title{connect method for BilanMigration}
\usage{
-\S4method{connect}{BilanMigration}(object, ...)
+\S4method{connect}{BilanMigration}(object)
}
\arguments{
\item{object}{An object of class \link{BilanMigration-class}}
Modified: pkg/stacomir/man/fn_table_per_dis.Rd
===================================================================
--- pkg/stacomir/man/fn_table_per_dis.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/fn_table_per_dis.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,22 +7,22 @@
fn_table_per_dis(typeperiode, tempsdebut, tempsfin, libelle, date = TRUE)
}
\arguments{
-\item{typeperiode}{ref.tr_typearretdisp_tar(per_tar_code) the code of the
+\item{typeperiode}{Ref.tr_typearretdisp_tar(per_tar_code) the code of the
period (see table ref.tr_typearretdisp_tar)}
-\item{tempsdebut}{ref.tr_typearretdisp_tar(per_date_debut) starting
+\item{tempsdebut}{Ref.tr_typearretdisp_tar(per_date_debut) starting
timestamp of the period}
\item{tempsfin}{The posgres column ref.tr_typearretdisp_tar(per_date_fin) ending timestamp of
the period}
+\item{libelle}{The posgres column ref.tr_typearretdisp_tar(libelle )description of the period
+type}
+
\item{date}{Boolean, should the function return a POSIXt or date value}
-
-\item{Libelle}{The posgres column ref.tr_typearretdisp_tar(libelle )description of the period
-type}
}
\value{
-listeg A list
+A list
}
\description{
functions called in DF and DC
Modified: pkg/stacomir/man/fntablestade.Rd
===================================================================
--- pkg/stacomir/man/fntablestade.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/fntablestade.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -12,7 +12,7 @@
\arguments{
\item{stades}{a data frame containing stage values}
-\item{choicelotpere}{either "date" or "lot_pere" the first will group pigment stage by date,
+\item{choicepere}{either "date" or "lot_pere" the first will group pigment stage by date,
the second will allow to keep separate lines when several samples have been collected a given day}
}
\value{
Modified: pkg/stacomir/man/fun_bilanMigrationMult.Rd
===================================================================
--- pkg/stacomir/man/fun_bilanMigrationMult.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/fun_bilanMigrationMult.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -9,8 +9,9 @@
\arguments{
\item{time.sequence}{the time sequence to be filled in with new data}
-\item{datasub}{the initial dataset
-#' @param negative "boolean", default FALSE, TRUE indicates a separate sum for negative and positive migrations}
+\item{datasub}{the initial dataset}
+
+\item{negative}{"boolean", default FALSE, TRUE indicates a separate sum for negative and positive migrations}
}
\value{
A data.frame with number summed over over the time.sequence.
Modified: pkg/stacomir/man/funbarchartDF.Rd
===================================================================
--- pkg/stacomir/man/funbarchartDF.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/funbarchartDF.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,7 +7,9 @@
funbarchartDF(h, ...)
}
\arguments{
-\item{h}{a handler}
+\item{h}{handler}
+
+\item{...}{additional parameters}
}
\description{
funbarchartDF creates a barchart for BilanFonctionnementDF class
Modified: pkg/stacomir/man/funboxDF.Rd
===================================================================
--- pkg/stacomir/man/funboxDF.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/funboxDF.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,7 +7,9 @@
funboxDF(h, ...)
}
\arguments{
-\item{h}{a handler}
+\item{h}{handler}
+
+\item{...}{additional parameters}
}
\description{
FunboxDF draws rectangles to describe the DF work for BilanFonctionnementDF class
Modified: pkg/stacomir/man/funcalcbilan_stades_pigm.Rd
===================================================================
--- pkg/stacomir/man/funcalcbilan_stades_pigm.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/funcalcbilan_stades_pigm.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -9,9 +9,7 @@
\arguments{
\item{h}{A handler}
-\item{additional}{arguments}
-
-\item{list()}{additional arguments}
+\item{...}{additional arguments}
}
\description{
Function with handler which calls charge (and thus connect) and calculates
Modified: pkg/stacomir/man/fundat.Rd
===================================================================
--- pkg/stacomir/man/fundat.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/fundat.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -2,20 +2,14 @@
% Please edit documentation in R/BilanMigrationInterAnnuelle.r
\name{fundat}
\alias{fundat}
-\title{@title statistics per time period
- function called for bilamMigrationInterannelle objects
- renames columnns replaces nulls,
- and calculates reports with time period larger than day
- @param timesplit "week" "2 week" "month" as provided to seq.POSIXT
- @return dat a data frame with max mean min per time period
-statistics per time period}
+\title{statistics per time period}
\usage{
fundat(dat, timesplit = NULL)
}
\arguments{
\item{dat}{a data frame}
-\item{timesplit}{"week" "2 week" "month" as provided to seq.POSIXT}
+\item{timesplit}{"week" "2 week" "month" as provided to seq.POSIXT, default NULL}
}
\value{
a data frame with mean, max, and min calculated for each timesplit
Modified: pkg/stacomir/man/fungraphgg.Rd
===================================================================
--- pkg/stacomir/man/fungraphgg.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/fungraphgg.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
fungraphgg(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
gglot function to draw graps of pigment stages
}
Modified: pkg/stacomir/man/funtableDC.Rd
===================================================================
--- pkg/stacomir/man/funtableDC.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/funtableDC.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,7 +7,9 @@
funtableDC(h, ...)
}
\arguments{
-\item{h}{a handler}
+\item{h}{Handler}
+
+\item{...}{Additional parameters}
}
\description{
FuntableDC create a table output for BilanFonctionnementDC class
Modified: pkg/stacomir/man/funtableDF.Rd
===================================================================
--- pkg/stacomir/man/funtableDF.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/funtableDF.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,7 +7,9 @@
funtableDF(h, ...)
}
\arguments{
-\item{h}{a handler}
+\item{h}{handler}
+
+\item{...}{additional parameters}
}
\description{
FuntableDF create a table output for BilanFonctionnementDF class
Modified: pkg/stacomir/man/getvalue-Refperiode-method.Rd
===================================================================
--- pkg/stacomir/man/getvalue-Refperiode-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/getvalue-Refperiode-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,6 +7,11 @@
\usage{
\S4method{getvalue}{Refperiode}(object, id, ...)
}
+\arguments{
+\item{object}{An object of class \link{Refperiode-class}}
+
+\item{id}{one of "jour", "semaine", "quinzaine", "mois"}
+}
\value{
"a character to be used in seq.POSIXt
}
Modified: pkg/stacomir/man/hBilanConditionEnv.Rd
===================================================================
--- pkg/stacomir/man/hBilanConditionEnv.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanConditionEnv.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanConditionEnv(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilanEspeces.Rd
===================================================================
--- pkg/stacomir/man/hBilanEspeces.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanEspeces.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanEspeces(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilanMigration.Rd
===================================================================
--- pkg/stacomir/man/hBilanMigration.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanMigration.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanMigration(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilanMigrationConditionEnv.Rd
===================================================================
--- pkg/stacomir/man/hBilanMigrationConditionEnv.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanMigrationConditionEnv.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanMigrationConditionEnv(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilanMigrationInterAnnuelle.Rd
===================================================================
--- pkg/stacomir/man/hBilanMigrationInterAnnuelle.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanMigrationInterAnnuelle.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanMigrationInterAnnuelle(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilanMigrationMult.Rd
===================================================================
--- pkg/stacomir/man/hBilanMigrationMult.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanMigrationMult.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanMigrationMult(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilanMigrationPar.Rd
===================================================================
--- pkg/stacomir/man/hBilanMigrationPar.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilanMigrationPar.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilanMigrationPar(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hBilan_carlot.Rd
===================================================================
--- pkg/stacomir/man/hBilan_carlot.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hBilan_carlot.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hBilan_carlot(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hCamembert.Rd
===================================================================
--- pkg/stacomir/man/hCamembert.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hCamembert.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -8,16 +8,16 @@
hCamembert(h, ...)
}
\arguments{
-\item{h}{handler}
+\item{h}{Handler}
-\item{...}{other parameters passed to the function}
+\item{...}{Other parameters passed to the function}
}
\description{
handler for pie chart
draws a pie chart of species or a pie chart per period
}
\note{
-no need to re-run calcul if another list has been loaded, negative numbers are converted to positive
+no need to re-run calculation if another list has been loaded, negative numbers are converted to positive
}
\author{
Cedric Briand \email{cedric.briand"at"eptb-vilaine.fr}
Modified: pkg/stacomir/man/hDC.Rd
===================================================================
--- pkg/stacomir/man/hDC.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hDC.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hDC(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hDF.Rd
===================================================================
--- pkg/stacomir/man/hDF.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hDF.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -1,18 +1,7 @@
% Generated by roxygen2: do not edit by hand
% Please edit documentation in R/stacomi.r
\name{hDF}
-\alias{h0,}
-\alias{hBilanConditionEnv,}
-\alias{hBilanLots,}
-\alias{hBilanMigrationPar,}
-\alias{hDC,hOPE,hDFDC,hBilanMigration,hBilanMigrationInterannuelle,hBilanMigrationConditionEnv,}
\alias{hDF}
-\alias{hSt,}
-\alias{hTail,}
-\alias{hX11}
-\alias{hhelp,}
-\alias{hpds,}
-\alias{htodo,}
\title{handler function used by the main interface}
\usage{
hDF(h, ...)
@@ -25,7 +14,4 @@
\description{
handler function used by the main interface
}
-\author{
-Cedric Briand \email{cedric.briand"at"eptb-vilaine.fr}
-}
Modified: pkg/stacomir/man/hDFDC.Rd
===================================================================
--- pkg/stacomir/man/hDFDC.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hDFDC.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -2,11 +2,16 @@
% Please edit documentation in R/stacomi.r
\name{hDFDC}
\alias{hDFDC}
-\title{handler function used by the main interface}
+\title{handler function used by the main interface#'}
\usage{
hDFDC(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
-handler function used by the main interface
+handler function used by the main interface#'
}
Modified: pkg/stacomir/man/hOPE.Rd
===================================================================
--- pkg/stacomir/man/hOPE.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hOPE.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hOPE(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hSt.Rd
===================================================================
--- pkg/stacomir/man/hSt.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hSt.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hSt(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/hTail.Rd
===================================================================
--- pkg/stacomir/man/hTail.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hTail.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hTail(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Added: pkg/stacomir/man/hbilanMigrationConditionEnvgraph.Rd
===================================================================
--- pkg/stacomir/man/hbilanMigrationConditionEnvgraph.Rd (rev 0)
+++ pkg/stacomir/man/hbilanMigrationConditionEnvgraph.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationConditionEnv.r
+\name{hbilanMigrationConditionEnvgraph}
+\alias{hbilanMigrationConditionEnvgraph}
+\title{plot combining one ore several qualitative parameters with the migration trend
+ @param h A handler
+ @param ... Additional parameters}
+\usage{
+hbilanMigrationConditionEnvgraph(h, ...)
+}
+\description{
+plot combining one ore several qualitative parameters with the migration trend
+ @param h A handler
+ @param ... Additional parameters
+}
+
Modified: pkg/stacomir/man/hbilanMigrationParcalc.Rd
===================================================================
--- pkg/stacomir/man/hbilanMigrationParcalc.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hbilanMigrationParcalc.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hbilanMigrationParcalc(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{Additional parameters}
+}
\description{
handler for bilanmigrationpar
}
Modified: pkg/stacomir/man/hbilanMigrationPargraph.Rd
===================================================================
--- pkg/stacomir/man/hbilanMigrationPargraph.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hbilanMigrationPargraph.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,7 +7,9 @@
hbilanMigrationPargraph(h, ...)
}
\arguments{
-\item{h, }{passed by the handler}
+\item{h}{handler}
+
+\item{...}{Additional parameters}
}
\description{
le handler appelle la methode generique graphe sur l'object plot.type=1
Modified: pkg/stacomir/man/hbilanMigrationPargraph2.Rd
===================================================================
--- pkg/stacomir/man/hbilanMigrationPargraph2.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hbilanMigrationPargraph2.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -7,7 +7,9 @@
hbilanMigrationPargraph2(h, ...)
}
\arguments{
-\item{h, }{passed by the handler}
+\item{h}{handler}
+
+\item{...}{Additional parameters}
}
\description{
le handler appelle la methode generique graphe sur l'object plot.type=2
Modified: pkg/stacomir/man/hbilanMigrationParstat.Rd
===================================================================
--- pkg/stacomir/man/hbilanMigrationParstat.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hbilanMigrationParstat.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -4,10 +4,12 @@
\alias{hbilanMigrationParstat}
\title{This handler calls the generic method graphe on object plot.type 3}
\usage{
-hbilanMigrationParstat(h, ...)
+hbilanMigrationParstat(h)
}
\arguments{
-\item{h, }{passed by}
+\item{h}{handler}
+
+\item{...}{Additional parameters}
}
\description{
This handler calls the generic method graphe on object plot.type 3
Modified: pkg/stacomir/man/hfungraphstades.Rd
===================================================================
--- pkg/stacomir/man/hfungraphstades.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hfungraphstades.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hfungraphstades(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function for fungraphstades
}
Added: pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle.Rd
===================================================================
--- pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle.Rd (rev 0)
+++ pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{hgraphBilanMigrationInterAnnuelle}
+\alias{hgraphBilanMigrationInterAnnuelle}
+\title{Plot of all interannual from top to bottom}
+\usage{
+hgraphBilanMigrationInterAnnuelle(h, ...)
+}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
+\description{
+Plot of all interannual from top to bottom
+}
+
Added: pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle2.Rd
===================================================================
--- pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle2.Rd (rev 0)
+++ pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle2.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,17 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{hgraphBilanMigrationInterAnnuelle2}
+\alias{hgraphBilanMigrationInterAnnuelle2}
+\title{Plot of daily migrations}
+\usage{
+hgraphBilanMigrationInterAnnuelle2(h, ...)
+}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
+\description{
+Plot of daily migrations
+}
+
Added: pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle3.Rd
===================================================================
--- pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle3.Rd (rev 0)
+++ pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle3.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,19 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{hgraphBilanMigrationInterAnnuelle3}
+\alias{hgraphBilanMigrationInterAnnuelle3}
+\title{Step plot with different years displayed on the same graph. One year
+can be highlighted against the others}
+\usage{
+hgraphBilanMigrationInterAnnuelle3(h, ...)
+}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
+\description{
+Step plot with different years displayed on the same graph. One year
+can be highlighted against the others
+}
+
Added: pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle4.Rd
===================================================================
--- pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle4.Rd (rev 0)
+++ pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle4.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,20 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{hgraphBilanMigrationInterAnnuelle4}
+\alias{hgraphBilanMigrationInterAnnuelle4}
+\title{Plot comparing the migration to the migration
+computed for all years available in the daily migration table.
+This function plots comparisions for periods of 1 week, 2 weeks, month
+ @param h A handler
+ @param ... Additional parameters}
+\usage{
+hgraphBilanMigrationInterAnnuelle4(h, ...)
+}
+\description{
+Plot comparing the migration to the migration
+computed for all years available in the daily migration table.
+This function plots comparisions for periods of 1 week, 2 weeks, month
+ @param h A handler
+ @param ... Additional parameters
+}
+
Added: pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle5.Rd
===================================================================
--- pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle5.Rd (rev 0)
+++ pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle5.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{hgraphBilanMigrationInterAnnuelle5}
+\alias{hgraphBilanMigrationInterAnnuelle5}
+\title{Function displaying comparaison similar to \link{hgraphBilanMigrationInterAnnuelle4} but using pointrange and geom_bar
+This function plots comparisions for periods of 1 week, 2 weeks, month
+ @param h A handler
+ @param ... Additional parameters}
+\usage{
+hgraphBilanMigrationInterAnnuelle5(h, ...)
+}
+\description{
+Function displaying comparaison similar to \link{hgraphBilanMigrationInterAnnuelle4} but using pointrange and geom_bar
+This function plots comparisions for periods of 1 week, 2 weeks, month
+ @param h A handler
+ @param ... Additional parameters
+}
+
Added: pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle7.Rd
===================================================================
--- pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle7.Rd (rev 0)
+++ pkg/stacomir/man/hgraphBilanMigrationInterAnnuelle7.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,18 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{hgraphBilanMigrationInterAnnuelle7}
+\alias{hgraphBilanMigrationInterAnnuelle7}
+\title{This function creates a cumulated area plot to highlight seasonal trends in migration. Data are calculated by
+2 weeks period then centered and reduced
+ @param h A handler
+ @param ... Additional parameters}
+\usage{
+hgraphBilanMigrationInterAnnuelle7(h, ...)
+}
+\description{
+This function creates a cumulated area plot to highlight seasonal trends in migration. Data are calculated by
+2 weeks period then centered and reduced
+ @param h A handler
+ @param ... Additional parameters
+}
+
Modified: pkg/stacomir/man/hpds.Rd
===================================================================
--- pkg/stacomir/man/hpds.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/hpds.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
hpds(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Added: pkg/stacomir/man/htableBilanMigrationInterAnnuelle.Rd
===================================================================
--- pkg/stacomir/man/htableBilanMigrationInterAnnuelle.Rd (rev 0)
+++ pkg/stacomir/man/htableBilanMigrationInterAnnuelle.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -0,0 +1,16 @@
+% Generated by roxygen2: do not edit by hand
+% Please edit documentation in R/BilanMigrationInterAnnuelle.r
+\name{htableBilanMigrationInterAnnuelle}
+\alias{htableBilanMigrationInterAnnuelle}
+\title{Writing of results in datawd
+ @param h A handler
+ @param ... Additional parameters}
+\usage{
+htableBilanMigrationInterAnnuelle(h, ...)
+}
+\description{
+Writing of results in datawd
+ @param h A handler
+ @param ... Additional parameters
+}
+
Modified: pkg/stacomir/man/htodo.Rd
===================================================================
--- pkg/stacomir/man/htodo.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/htodo.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -6,6 +6,11 @@
\usage{
htodo(h, ...)
}
+\arguments{
+\item{h}{handler}
+
+\item{...}{additional parameters}
+}
\description{
handler function used by the main interface
}
Modified: pkg/stacomir/man/plot-BilanMigration-ANY-method.Rd
===================================================================
--- pkg/stacomir/man/plot-BilanMigration-ANY-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/plot-BilanMigration-ANY-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -16,6 +16,8 @@
\item{plot.type}{One of "standard","step". Defaut to \code{standard} the standard BilanMigration with dc and operation displayed, can also be \code{step} or
\code{multiple}}
+\item{silent}{Stops displaying the messages.}
+
\item{...}{Additional arguments, see \code{plot}, \code{plot.default} and \code{par}}
}
\description{
Modified: pkg/stacomir/man/plot-BilanMigrationMult-ANY-method.Rd
===================================================================
--- pkg/stacomir/man/plot-BilanMigrationMult-ANY-method.Rd 2016-09-08 19:45:25 UTC (rev 201)
+++ pkg/stacomir/man/plot-BilanMigrationMult-ANY-method.Rd 2016-09-09 17:53:04 UTC (rev 202)
@@ -16,6 +16,8 @@
[TRUNCATED]
To get the complete diff run:
svnlook diff /svnroot/stacomir -r 202
More information about the Stacomir-commits
mailing list