[Distr-commits] r1369 - branches/distr-2.9/pkg/distrMod/man pkg/distrMod/man

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

Author: ruckdeschel
Date: 2022-06-15 00:43:14 +0200 (Wed, 15 Jun 2022)
New Revision: 1369

Modified:
   branches/distr-2.9/pkg/distrMod/man/trafo-methods.Rd
   pkg/distrMod/man/trafo-methods.Rd
Log:
[distrMod] devel- and release (2.8.5) branch:
fixed another occurrence of a bad usage of \item in a \value section in trafo-methods.R

Modified: branches/distr-2.9/pkg/distrMod/man/trafo-methods.Rd
===================================================================
--- branches/distr-2.9/pkg/distrMod/man/trafo-methods.Rd	2022-06-13 19:05:04 UTC (rev 1368)
+++ branches/distr-2.9/pkg/distrMod/man/trafo-methods.Rd	2022-06-14 22:43:14 UTC (rev 1369)
@@ -45,20 +45,7 @@
   conditions as above).}
   \item{\dots}{additional argument(s) for methods; not used so far.}
 }
-\value{
-  The return value depends on the signature.
-  For \code{trafo.fct}, we return the corresponding function 
-  \eqn{\tau()}{tau()} (see below).
-  For \code{trafo}, we have:
-  \item{signature \code{Estimate,missing}:}{a list of length two with components
-  \code{fct} and \code{mat} (see below)}
-  \item{signature \code{Estimate,ParamFamParameter}:}{a list of length two with components
-  \code{fct} and \code{mat} (see below)}
-  \item{signature \code{ParamFamParameter,missing}:}{a matrix (see below)}
-  \item{signature \code{ParamFamily,missing}:}{a matrix (see below)}
-  \item{signature \code{ParamFamily,ParamFamParameter}:}{a list of length two
-  with components \code{fct} and \code{mat} (see below)}
-  }
+
 \details{
   \code{trafo} is a slot of class \code{ParamFamParameter}, which
   in turn is a slot of class \code{ParamFamily}. It also sort of
@@ -65,11 +52,32 @@
   arises in class \code{Estimate}, i.e., all slots can be identified
   by the information contained in an instance thereof.
 
+  As usual, \code{trafo} also is the accessor and replacement method 
+  for this slot. Its corresponding return value depends on the signature
+  for which the accessor / replacement method is used. More specifically,
+  for \code{trafo}, we have methods for the following signatures:
+  \describe{
+  \item{signature \code{Estimate,missing}:}{returns a list of length two with components
+  \code{fct} and \code{mat} (see below)}
+  \item{signature \code{Estimate,ParamFamParameter}:}{returns a list of length two with components
+  \code{fct} and \code{mat} (see below)}
+  \item{signature \code{ParamFamParameter,missing}:}{returns a matrix (see below)}
+  \item{signature \code{ParamFamily,missing}:}{returns a matrix (see below)}
+  \item{signature \code{ParamFamily,ParamFamParameter}:}{returns a list of length two
+  with components \code{fct} and \code{mat} (see below)}
+  }
+  
+  
   \code{trafo} realizes partial influence curves; i.e.; we are only
   interested in some possibly lower dimensional smooth (not necessarily
   linear or even coordinate-wise) aspect/transformation \eqn{\tau}{tau}
   of the parameter \eqn{\theta}{theta}.
 
+  For the this function \eqn{\tau()}{tau()}, we provide an accessor 
+  \code{trafo.fct} for signature \code{ParamFamily-method}
+  returning this function.  
+  
+
   To be coherent with the corresponding \emph{nuisance}
   implementation, we make the following convention:
 

Modified: pkg/distrMod/man/trafo-methods.Rd
===================================================================
--- pkg/distrMod/man/trafo-methods.Rd	2022-06-13 19:05:04 UTC (rev 1368)
+++ pkg/distrMod/man/trafo-methods.Rd	2022-06-14 22:43:14 UTC (rev 1369)
@@ -45,20 +45,7 @@
   conditions as above).}
   \item{\dots}{additional argument(s) for methods; not used so far.}
 }
-\value{
-  The return value depends on the signature.
-  For \code{trafo.fct}, we return the corresponding function 
-  \eqn{\tau()}{tau()} (see below).
-  For \code{trafo}, we have:
-  \item{signature \code{Estimate,missing}:}{a list of length two with components
-  \code{fct} and \code{mat} (see below)}
-  \item{signature \code{Estimate,ParamFamParameter}:}{a list of length two with components
-  \code{fct} and \code{mat} (see below)}
-  \item{signature \code{ParamFamParameter,missing}:}{a matrix (see below)}
-  \item{signature \code{ParamFamily,missing}:}{a matrix (see below)}
-  \item{signature \code{ParamFamily,ParamFamParameter}:}{a list of length two
-  with components \code{fct} and \code{mat} (see below)}
-  }
+
 \details{
   \code{trafo} is a slot of class \code{ParamFamParameter}, which
   in turn is a slot of class \code{ParamFamily}. It also sort of
@@ -65,11 +52,32 @@
   arises in class \code{Estimate}, i.e., all slots can be identified
   by the information contained in an instance thereof.
 
+  As usual, \code{trafo} also is the accessor and replacement method 
+  for this slot. Its corresponding return value depends on the signature
+  for which the accessor / replacement method is used. More specifically,
+  for \code{trafo}, we have methods for the following signatures:
+  \describe{
+  \item{signature \code{Estimate,missing}:}{returns a list of length two with components
+  \code{fct} and \code{mat} (see below)}
+  \item{signature \code{Estimate,ParamFamParameter}:}{returns a list of length two with components
+  \code{fct} and \code{mat} (see below)}
+  \item{signature \code{ParamFamParameter,missing}:}{returns a matrix (see below)}
+  \item{signature \code{ParamFamily,missing}:}{returns a matrix (see below)}
+  \item{signature \code{ParamFamily,ParamFamParameter}:}{returns a list of length two
+  with components \code{fct} and \code{mat} (see below)}
+  }
+  
+  
   \code{trafo} realizes partial influence curves; i.e.; we are only
   interested in some possibly lower dimensional smooth (not necessarily
   linear or even coordinate-wise) aspect/transformation \eqn{\tau}{tau}
   of the parameter \eqn{\theta}{theta}.
 
+  For the this function \eqn{\tau()}{tau()}, we provide an accessor 
+  \code{trafo.fct} for signature \code{ParamFamily-method}
+  returning this function.  
+  
+
   To be coherent with the corresponding \emph{nuisance}
   implementation, we make the following convention: