Header menu logo bristlecone

EstimationResult Module

Functions and values

Function or value Description

EstimationResult.loadAll directory subject modelSystem modelId

Full Usage: EstimationResult.loadAll directory subject modelSystem modelId

Parameters:
    directory : string
    subject : string
    modelSystem : ModelSystem
    modelId : string

Returns: EstimationResult seq

Load an `EstimationResult` that has previously been saved as three seperate dataframes. Results will only be reconstructed when file names and formats are in original Bristlecone format.

directory : string
subject : string
modelSystem : ModelSystem
modelId : string
Returns: EstimationResult seq

EstimationResult.saveAll directory subject modelId thinTraceBy result

Full Usage: EstimationResult.saveAll directory subject modelId thinTraceBy result

Parameters:
    directory : string - Relative or absolute directory to save files to
    subject : string - An identifier for the subject of the test
    modelId : string - An identifier for the model used
    thinTraceBy : int option - If Some, an integer representing the nth traces to keep from the optimisation trace. If None, does not thin the trace.
    result : EstimationResult - The estimation result to save

Save the Maximum Likelihood Estimate, trace of the optimisation procedure, and time-series.

directory : string

Relative or absolute directory to save files to

subject : string

An identifier for the subject of the test

modelId : string

An identifier for the model used

thinTraceBy : int option

If Some, an integer representing the nth traces to keep from the optimisation trace. If None, does not thin the trace.

result : EstimationResult

The estimation result to save

Type something to start searching.