From 56f0fabff0e4d31868a7e3f93c83583188bba650 Mon Sep 17 00:00:00 2001
From: unknown <olivier.delaigue@ANPI1430.antony.irstea.priv>
Date: Tue, 25 Oct 2016 14:54:43 +0200
Subject: [PATCH] Adding an example for the "FixedParam" argument in the
documentation of the CreateCalibOptions() function
---
man/CreateCalibOptions.Rd | 7 ++++++-
1 file changed, 6 insertions(+), 1 deletion(-)
diff --git a/man/CreateCalibOptions.Rd b/man/CreateCalibOptions.Rd
index 530f1747..2fad455a 100644
--- a/man/CreateCalibOptions.Rd
+++ b/man/CreateCalibOptions.Rd
@@ -15,7 +15,12 @@ CreateCalibOptions(FUN_MOD, FUN_CALIB = Calibration_Michel,
\item{FUN_TRANSFO}{(optional) [function] model parameters transformation function, if the FUN_MOD used is native in the package, FUN_TRANSFO is automatically defined}
-\item{FixedParam}{(optional) [numeric] vector giving the values set for the non-optimised parameter values (NParam columns, 1 line)}
+\item{FixedParam}{(optional) [numeric] vector giving the values set for the non-optimised parameter values (NParam columns, 1 line)
+\cr Example:
+\tabular{llllll}{
+ \tab [X1] \tab [X2] \tab [X3] \tab [...] \tab [Xi] \cr
+ [1,] \tab NA \tab NA \tab 3.34 \tab ... \tab NA \cr
+}}
\item{SearchRanges}{(optional) [numeric] matrix giving the ranges of real parameters (NParam columns, 2 lines)
\cr Example:
--
GitLab