aa_summariseReplicateRuns: Summarise results in set folder structure into one single CSV...

Description Usage Arguments

Description

Only to be applied in cases where simulation responses are supplied in the folder structure (as in all previous versions of Spartan), useful for cases where the simulation is non-deterministic. Iterates through simulation runs for each sample size creating a CSV file containing results for all sample sizes and all subsets (in the same format as the new CSV file format discussed above). Where a simulation response is comprised of a number of records (for example a number of cells), the median value will be recorded as the response for this subset of the sample size being analysed. This file is output to a CSV file, named as stated by the parameter SUMMARYFILENAME. If doing this analysis over multiple timepoints, the timepoint will be appended to the filename given in SUMMARYFILENAME

Usage

1
2
3
4
aa_summariseReplicateRuns(FILEPATH, SAMPLESIZES, MEASURES, RESULTFILENAME,
  ALTFILENAME = NULL, OUTPUTFILECOLSTART, OUTPUTFILECOLEND,
  SUMMARYFILENAME, NUMSUBSETSPERSAMPLESIZE = 20, TIMEPOINTS = NULL,
  TIMEPOINTSCALE = NULL, check_done = FALSE)

Arguments

FILEPATH

Directory where the results of the simulation runs, in folders or in single CSV file format, can be found

SAMPLESIZES

The sample sizes chosen (i.e. in our case, this would be an array containing 1,5,50,100,300,800

MEASURES

An array containing the names of the simulation output measures to be analysed.

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.

OUTPUTFILECOLSTART

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.

OUTPUTFILECOLEND

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

SUMMARYFILENAME

Name of the file generated that lists the maximum and median A-Test results for each sample size.

NUMSUBSETSPERSAMPLESIZE

Number of subsets of simulation runs for each sample size. Defaults to 20

TIMEPOINTS

Implemented so this method can be used when analysing multiple simulation timepoints. If only analysing one timepoint, this should be set to NULL. If not, this should be an array of timepoints, e.g. c(12,36,48,60)

TIMEPOINTSCALE

Implemented so this method can be used when analysing multiple simulation timepoints. Sets the scale of the timepoints being analysed, e.g. "Hours"

check_done

If multiple timepoints, whether the input has been checked


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