From 36036b5901223591e7e21e8b73d8cd1fb034f4cb Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Tue, 16 May 2017 15:43:50 +0200 Subject: Finish the Step 1 calculator including tests Some cleaning up. PELMO facilities do not currently work at my end, as I have no working wine installation on this computer --- docs/reference/one_box.html | 53 +++++++++++++++++++++++++++++---------------- 1 file changed, 34 insertions(+), 19 deletions(-) (limited to 'docs/reference/one_box.html') diff --git a/docs/reference/one_box.html b/docs/reference/one_box.html index 800ca66..931e722 100644 --- a/docs/reference/one_box.html +++ b/docs/reference/one_box.html @@ -25,12 +25,14 @@ - + + + @@ -73,7 +75,7 @@

Create a time series of decline data

one_box(x, ini, ..., t_end = 100, res = 0.01)
+    one_box(x, ini, ..., t_end = 100, res = 0.01)
 
 # S3 method for numeric
 one_box(x, ini = 1, ..., t_end = 100, res = 0.01)
@@ -86,28 +88,41 @@
 one_box(x, ini = "model", ..., t_end = 100, res = 0.01)
     
      Arguments
-    
-      x
-      When numeric, this is the half-life to be used for an exponential
+    
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    
+      
+      
+    
+    x When numeric, this is the half-life to be used for an exponential
 decline. When a character string specifying a parent decline model is given
 e.g. FOMC, parms must contain the corresponding paramters.
 If x is an mkinfit object, the decline is calculated from this
-object.
-      
ini
-      The initial amount. If x is an mkinfit object, and
-ini is 'model', the fitted initial concentrations are used. Otherwise, ini
+object.
ini The initial amount. If x is an mkinfit object, and
+ini is 'model', the fitted initial concentrations are used. Otherwise, ini
 must be numeric. If it has length one, it is used for the parent and
 initial values of metabolites are zero, otherwise, it must give values for
-all observed variables.
-      
...
-      Further arguments passed to methods
-      t_end
-      End of the time series
-      res
-      Resolution of the time series
-      parms
-      A named numeric vector containing the model parameters
-    
+all observed variables.
... Further arguments passed to methods
t_end End of the time series
res Resolution of the time series
parms A named numeric vector containing the model parameters
     
     Value
 
-- 
cgit v1.2.1

x	When numeric, this is the half-life to be used for an exponential decline. When a character string specifying a parent decline model is given e.g. `FOMC`, `parms` must contain the corresponding paramters. If x is an `mkinfit` object, the decline is calculated from this -object. - ini - The initial amount. If x is an `mkinfit` object, and -ini is 'model', the fitted initial concentrations are used. Otherwise, ini +object.
ini	The initial amount. If x is an `mkinfit` object, and +ini is 'model', the fitted initial concentrations are used. Otherwise, ini must be numeric. If it has length one, it is used for the parent and initial values of metabolites are zero, otherwise, it must give values for -all observed variables. - ... - Further arguments passed to methods - t_end - End of the time series - res - Resolution of the time series - parms - A named numeric vector containing the model parameters - +all observed variables.
...	Further arguments passed to methods
t_end	End of the time series
res	Resolution of the time series
parms	A named numeric vector containing the model parameters