From ccc70e82af4ba435f0a71ba1ae4e0e92045c3852 Mon Sep 17 00:00:00 2001 From: Johannes Ranke Date: Fri, 5 May 2017 12:46:31 +0200 Subject: Static docs except articles rebuilt with current pkgdown --- docs/reference/index.html | 537 +++++++++++++++++++++++++--------------------- 1 file changed, 297 insertions(+), 240 deletions(-) (limited to 'docs/reference/index.html') diff --git a/docs/reference/index.html b/docs/reference/index.html index 2e997ef0..16280a9d 100644 --- a/docs/reference/index.html +++ b/docs/reference/index.html @@ -25,12 +25,14 @@ - + + + @@ -70,6 +72,9 @@
  • Performance benefit by using compiled model definitions in mkin
  • +
  • + Calculation of time weighted average concentrations with mkin +
  • @@ -95,250 +100,302 @@
    -

    Main functions

    -

    Essential functionality

    - - -

    -

    - - -

    -

    - - -

    -

    - -

    Show results

    -

    Functions working with mkinfit objects

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - -

    Work with mmkin objects

    -

    Functions working with aggregated results

    - - -

    Subsetting method for mmkin objects

    - - -

    -

    - -

    Datasets and known results

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    A dataset class for mkin

    - - -

    -

    - -

    Helper functions

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    -

    - - -

    Calculate the geometric mean

    - -

    Analytical solutions

    -

    Parent only model solutions

    + - -

    Single First-Order kinetics

    - - -

    First-Order Multi-Compartment kinetics

    - - -

    -

    - - -

    Single First-Order Reversible Binding kinetics

    - - -

    Hockey-Stick kinetics

    - - -

    Indeterminate order rate equation kinetics

    - -

    Generate synthetic datasets

    -

    + + + + - -

    -

    - -

    Deprecated functions

    -

    Functions that have been superseeded

    - - -

    -

    - - + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +

    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 with mkinfit objects

    +
    +

    plot.mkinfit

    +

    Plot the observed data and the fitted model of an mkinfit object

    +

    summary print

    +

    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

    +
    +

    plot

    +

    Plot model fits (observed and fitted) and the residuals for a row or column of an mmkin object

    +

    Datasets and known results

    +

    +
    +

    FOCUS_2006_datasets

    +

    Datasets A to F from the FOCUS Kinetics report from 2006

    +

    data

    +

    Results of fitting the SFO model to Datasets A to F of FOCUS (2006)

    +

    data

    +

    Results of fitting the FOMC model to Datasets A to F of FOCUS (2006)

    +

    data

    +

    Results of fitting the HS model to Datasets A to F of FOCUS (2006)

    +

    data

    +

    Results of fitting the DFOP model to Datasets A to B of FOCUS (2006)

    +

    mccall81_245T

    +

    Datasets on aerobic soil metabolism of 2,4,5-T in six soils

    +

    data

    +

    Metabolism data set used for checking the software quality of KinGUI

    +

    synthetic_data_for_UBA_2014

    +

    Synthetic datasets for one parent compound with two metabolites

    +

    mkinds

    +

    A dataset class for mkin

    +

    print

    +

    Print mkinds objects

    +

    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

    +

    print

    +

    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

    +
    +

    SFO.solution

    +

    Single First-Order kinetics

    +

    FOMC.solution

    +

    First-Order Multi-Compartment kinetics

    +

    DFOP.solution

    +

    Double First-Order in Parallel kinetics

    +

    SFORB.solution

    +

    Single First-Order Reversible Binding kinetics

    +

    HS.solution

    +

    Hockey-Stick kinetics

    +

    IORE.solution

    +

    Indeterminate order rate equation kinetics

    +

    Generate synthetic datasets

    +

    +
    +

    add_err

    +

    Add normally distributed errors to simulated kinetic degradation data

    +

    Deprecated functions

    +

    Functions that have been superseeded

    +
    +

    mkinplot

    +

    Plot the observed data and the fitted model of an mkinfit object

    -- cgit v1.2.1