From a350a16bb2c11986faf5883a2804d46b03bd7c8f Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Sat, 10 Sep 2016 05:21:52 +0200 Subject: Static documentation rebuilt with current staticdocs Using hadley/staticdocs commit #8c1069d from 8 days ago --- docs/reference.html | 288 ++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 288 insertions(+) create mode 100644 docs/reference.html (limited to 'docs/reference.html') diff --git a/docs/reference.html b/docs/reference.html new file mode 100644 index 00000000..df1bd9a8 --- /dev/null +++ b/docs/reference.html @@ -0,0 +1,288 @@ + + + + +Function reference. mkin 0.9.44.9000 + + + + + + + + + + + + + + + +
+
+
+ mkin 0.9.44.9000 +
+ +
+
+
+
+ + +
+
+ +
+ +
+
+

Function reference

+ +

Main functions

+

Essential functionality

+ + +
    + +
  • + mkinmod
    + Function to set up a kinetic model with one or more state variables +
    • + +
  • + mkinfit
    + Fit a kinetic model to data with one or more state variables +
    • + +
  • + mmkin
    + Fit one or more kinetic models with one or more state variables to one or more datasets +
    • + +
+

Show results

+

Functions working on mkinfit objects

+ + +
    + +
  • + plot.mkinfit(plot_sep)
    + Plot the observed data and the fitted model of an mkinfit object +
    • + +
  • + summary.mkinfit(print.summary.mkinfit)
    + Summary method for class "mkinfit" +
    • + +
  • + mkinresplot
    + Function to plot residuals stored in an mkin object +
    • + +
  • + mkinparplot
    + Function to plot the confidence intervals obtained using + mkinfit +
    • + +
  • + endpoints
    +Function to calculate endpoints for further use from kinetic models fitted with mkinfit +
    • + +
  • + mkinerrmin
    +Calculate the minimum error to assume in order to pass the variance test +
    • + +
+

Work with mmkin objects

+

Functions working with aggregated results

+ + +
    + +
  • + [.mmkin
    Subsetting method for mmkin objects
    • + +
  • + plot.mmkin
    + Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object +
    • + +
+

Datasets and known results

+ + + +

Helper functions

+ + +
    + +
  • + mkin_wide_to_long
    + Convert a dataframe with observations over time into long format +
    • + +
  • + mkin_long_to_wide
    + Convert a dataframe from long to wide format +
    • + +
  • + mkinsub
    + Function to set up a kinetic submodel for one state variable +
    • + +
  • + mkinds
    A dataset class for mkin
    • + +
  • + print.mkinds
    + Print mkinds objects +
    • + +
  • + print.mkinmod
    + Print mkinmod objects +
    • + +
  • + mkinpredict
    + Produce predictions from a kinetic model using specific parameters +
    • + +
  • + transform_odeparms(backtransform_odeparms)
    + Functions to transform and backtransform kinetic parameters for fitting +
    • + +
  • + ilr(invilr)
    + Function to perform isometric log-ratio transformation +
    • + +
  • + geometric_mean
    Calculate the geometric mean
    • + +
+

Analytical solutions

+

Parent only model solutions

+ + + +

Deprecated functions

+

Functions that have been superseeded

+ + +
    + +
  • + mkinplot
    + Plot the observed data and the fitted model of an mkinfit object +
    • + +
+

Other

+ + +
    + +
  • + add_err
    + Add normally distributed errors to simulated kinetic degradation data +
    • + +
+
+
+ + +
+ + \ No newline at end of file -- cgit v1.2.1