[Stacomir-commits] r609 - in pkg/stacomir: . man

[noreply at r-forge.r-project.org]

Author: briand
Date: 2021-11-16 11:26:21 +0100 (Tue, 16 Nov 2021)
New Revision: 609

Removed:
   pkg/stacomir/man/charge-report_ge_weight-method.Rd
   pkg/stacomir/man/createmessage.Rd
   pkg/stacomir/man/current_end_date-ref_timestep-method.Rd
   pkg/stacomir/man/current_end_date.Rd
   pkg/stacomir/man/currentstart_date-ref_timestep-method.Rd
   pkg/stacomir/man/currentstart_date.Rd
   pkg/stacomir/man/get_step_label-ref_timestep-method.Rd
   pkg/stacomir/man/get_step_label.Rd
   pkg/stacomir/man/getdateDebut-ref_timestep-method.Rd
   pkg/stacomir/man/getdateDebut.Rd
   pkg/stacomir/man/getnocurrent_step-ref_timestep-method.Rd
   pkg/stacomir/man/getnocurrent_step.Rd
   pkg/stacomir/man/set_starting_date-ref_timestep-method.Rd
   pkg/stacomir/man/set_starting_date.Rd
Modified:
   pkg/stacomir/NAMESPACE
Log:
fixed documentation

Modified: pkg/stacomir/NAMESPACE
===================================================================
--- pkg/stacomir/NAMESPACE	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/NAMESPACE	2021-11-16 10:26:21 UTC (rev 609)
@@ -6,7 +6,6 @@
 export(charge_with_filter)
 export(choice_c)
 export(colortable)
-export(createmessage)
 export(envir_stacomi)
 export(fun_aggreg_for_plot)
 export(fun_date_extraction)

Deleted: pkg/stacomir/man/charge-report_ge_weight-method.Rd
===================================================================
--- pkg/stacomir/man/charge-report_ge_weight-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/charge-report_ge_weight-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,21 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/report_ge_weight.R
-\name{charge,report_ge_weight-method}
-\alias{charge,report_ge_weight-method}
-\alias{charge.report_ge_weight}
-\title{charge method for report_ge_weight class}
-\usage{
-\S4method{charge}{report_ge_weight}(object)
-}
-\arguments{
-\item{object}{An object of class \link{report_ge_weight-class}}
-}
-\value{
-report_ge_weight with slots filled with user choice
-}
-\description{
-charge method for report_ge_weight class
-}
-\author{
-Cedric Briand \email{cedric.briand'at'eptb-vilaine.fr}
-}

Deleted: pkg/stacomir/man/createmessage.Rd
===================================================================
--- pkg/stacomir/man/createmessage.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/createmessage.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,19 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/create_generic.R
-\name{createmessage}
-\alias{createmessage}
-\title{Generic method to forward outputs}
-\usage{
-createmessage(object, ...)
-}
-\arguments{
-\item{object}{Object}
-
-\item{...}{Additional parms}
-}
-\description{
-Generic method to forward outputs
-}
-\author{
-cedric.briand
-}

Deleted: pkg/stacomir/man/current_end_date-ref_timestep-method.Rd
===================================================================
--- pkg/stacomir/man/current_end_date-ref_timestep-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/current_end_date-ref_timestep-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{current_end_date,ref_timestep-method}
-\alias{current_end_date,ref_timestep-method}
-\title{Gets the ending date of a time step for an object of class \link{ref_timestep-class}}
-\usage{
-\S4method{current_end_date}{ref_timestep}(object)
-}
-\arguments{
-\item{object}{An object of class \link{ref_timestep-class}}
-}
-\value{
-Currentend_date, The ending date for the current timestep
-}
-\description{
-Gets the ending date of a time step for an object of class \link{ref_timestep-class}
-}

Deleted: pkg/stacomir/man/current_end_date.Rd
===================================================================
--- pkg/stacomir/man/current_end_date.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/current_end_date.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/create_generic.R
-\name{current_end_date}
-\alias{current_end_date}
-\title{Generic method for getting the ending date for current time step}
-\usage{
-current_end_date(object, ...)
-}
-\arguments{
-\item{object}{An object}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Generic method for getting the ending date for current time step
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/currentstart_date-ref_timestep-method.Rd
===================================================================
--- pkg/stacomir/man/currentstart_date-ref_timestep-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/currentstart_date-ref_timestep-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,18 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{currentstart_date,ref_timestep-method}
-\alias{currentstart_date,ref_timestep-method}
-\title{Gets the starting date of a time step for an object of class \link{ref_timestep-class}}
-\usage{
-\S4method{currentstart_date}{ref_timestep}(object)
-}
-\arguments{
-\item{object}{An object of class \link{ref_timestep-class}}
-}
-\value{
-current_start_date, The starting date for the current timestep
-}
-\description{
-Gets the starting date of a time step for an object of class \link{ref_timestep-class}
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/currentstart_date.Rd
===================================================================
--- pkg/stacomir/man/currentstart_date.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/currentstart_date.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/create_generic.R
-\name{currentstart_date}
-\alias{currentstart_date}
-\title{Generic method for getting the beginning date for current time step}
-\usage{
-currentstart_date(object, ...)
-}
-\arguments{
-\item{object}{An object}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Generic method for getting the beginning date for current time step
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/get_step_label-ref_timestep-method.Rd
===================================================================
--- pkg/stacomir/man/get_step_label-ref_timestep-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/get_step_label-ref_timestep-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,18 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{get_step_label,ref_timestep-method}
-\alias{get_step_label,ref_timestep-method}
-\title{Gets the string value of time step}
-\usage{
-\S4method{get_step_label}{ref_timestep}(object)
-}
-\arguments{
-\item{object}{An object of class \link{ref_timestep-class}}
-}
-\value{
-A string corresponding to the value of current time step
-}
-\description{
-Gets the string value of time step
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/get_step_label.Rd
===================================================================
--- pkg/stacomir/man/get_step_label.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/get_step_label.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/create_generic.R
-\name{get_step_label}
-\alias{get_step_label}
-\title{Generic method to get the string value of time step}
-\usage{
-get_step_label(object, ...)
-}
-\arguments{
-\item{object}{An object}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Generic method to get the string value of time step
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/getdateDebut-ref_timestep-method.Rd
===================================================================
--- pkg/stacomir/man/getdateDebut-ref_timestep-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/getdateDebut-ref_timestep-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{getdateDebut,ref_timestep-method}
-\alias{getdateDebut,ref_timestep-method}
-\title{Returns the starting date as character}
-\usage{
-\S4method{getdateDebut}{ref_timestep}(object)
-}
-\arguments{
-\item{object}{An object of class \link{ref_timestep-class}}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Returns the starting date as character
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/getdateDebut.Rd
===================================================================
--- pkg/stacomir/man/getdateDebut.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/getdateDebut.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/create_generic.R
-\name{getdateDebut}
-\alias{getdateDebut}
-\title{Generic method the get starting date}
-\usage{
-getdateDebut(object, ...)
-}
-\arguments{
-\item{object}{An object}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Generic method the get starting date
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/getnocurrent_step-ref_timestep-method.Rd
===================================================================
--- pkg/stacomir/man/getnocurrent_step-ref_timestep-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/getnocurrent_step-ref_timestep-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,18 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{getnocurrent_step,ref_timestep-method}
-\alias{getnocurrent_step,ref_timestep-method}
-\title{Gets the current time step of an object of class \link{ref_timestep-class}}
-\usage{
-\S4method{getnocurrent_step}{ref_timestep}(object)
-}
-\arguments{
-\item{object}{An object of class \link{ref_timestep-class}}
-}
-\value{
-the current time step of the object
-}
-\description{
-Gets the current time step of an object of class \link{ref_timestep-class}
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/getnocurrent_step.Rd
===================================================================
--- pkg/stacomir/man/getnocurrent_step.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/getnocurrent_step.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,16 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{getnocurrent_step}
-\alias{getnocurrent_step}
-\title{Generic method to get current time step}
-\usage{
-getnocurrent_step(object, ...)
-}
-\arguments{
-\item{object}{An object}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Generic method to get current time step
-}

Deleted: pkg/stacomir/man/set_starting_date-ref_timestep-method.Rd
===================================================================
--- pkg/stacomir/man/set_starting_date-ref_timestep-method.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/set_starting_date-ref_timestep-method.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,21 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/ref_timestep.R
-\name{set_starting_date,ref_timestep-method}
-\alias{set_starting_date,ref_timestep-method}
-\title{Sets starting date from a character}
-\usage{
-\S4method{set_starting_date}{ref_timestep}(object, string)
-}
-\arguments{
-\item{object}{An object of class \link{ref_timestep-class}}
-
-\item{string}{Character string of type"\%Y-\%m-\%d \%H:\%M:\%S" or "\%Y-\%m-\%d".
-this allows to use either horodate or date}
-}
-\value{
-An object of class \link{ref_timestep-class}
-}
-\description{
-Sets starting date from a character
-}
-\keyword{internal}

Deleted: pkg/stacomir/man/set_starting_date.Rd
===================================================================
--- pkg/stacomir/man/set_starting_date.Rd	2021-11-16 09:32:32 UTC (rev 608)
+++ pkg/stacomir/man/set_starting_date.Rd	2021-11-16 10:26:21 UTC (rev 609)
@@ -1,17 +0,0 @@
-% Generated by roxygen2: do not edit by hand
-% Please edit documentation in R/create_generic.R
-\name{set_starting_date}
-\alias{set_starting_date}
-\title{Generic method to set the starting date}
-\usage{
-set_starting_date(object, ...)
-}
-\arguments{
-\item{object}{An object}
-
-\item{...}{Additional parameters passed to the method}
-}
-\description{
-Generic method to set the starting date
-}
-\keyword{internal}