summarise_lhc_sweep_responses: Processes an LHC sample, returning summary stats for all...

Description Usage Arguments Value

Description

Processes an LHC sample, returning summary stats for all parameter sets

Usage

1
2
3
summarise_lhc_sweep_responses(filepath, numrunspersample, parameters,
  measures, resultfilename, altfilename, num_samples, lhctable,
  outputcolstart, outputcolend)

Arguments

filepath

Directory where the simulation runs of single CSV file can be found

numrunspersample

The number of runs performed for each parameter subset. This figure is generated through Aleatory Analysis. Only required if analysing results provided within Folder structure setup.

parameters

Simulation parameters being analysed / perturbed

measures

Array containing the names of the output measures which are used to analyse the simulation

resultfilename

Name of the simulation results file. In the current version, XML and CSV files can be processed. If performing this analysis over multiple timepoints, it is assumed that the timepoint follows the file name, e.g. trackedCells_Close_12.csv.

altfilename

In some cases, it may be relevant to read from a further results file if the initial file contains no results. This filename is set here. In the current version, XML and CSV files can be processed.

num_samples

The number of parameter subsets that were generated in the LHC design. Only required if analysing results provided within Folder structure setup.

lhctable

Parameter sets generated by LHC sampling

outputcolstart

Column number in the simulation results file where output begins - saves (a) reading in unnecessary data, and (b) errors where the first column is a label, and therefore could contain duplicates.

outputcolend

Column number in the simulation results file where the last output measure is.

Value

Summary stats for all parameter sets


kalden/spartan documentation built on May 31, 2019, 11:52 p.m.