aa_getATestResults_overTime: Get A-Test results for multiple simulation timepoints

Description Usage Arguments

View source: R/aleatory_analysis.R

Description

Get A-Test results for multiple simulation timepoints

Usage

1
2
3
4
aa_getATestResults_overTime(FILEPATH, SAMPLESIZES, NUMSUBSETSPERSAMPLESIZE,
  MEASURES, ATESTRESULTSFILENAME, LARGEDIFFINDICATOR,
  AA_SIM_RESULTS_FILE = NULL, AA_SIM_RESULTS_OBJECT = NULL, TIMEPOINTS,
  TIMEPOINTSCALE, GRAPHNAME = NULL)

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

NUMSUBSETSPERSAMPLESIZE

The number of subsets for each sample size (i.e in the tutorial case, 20)

MEASURES

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

ATESTRESULTSFILENAME

Name of the file that will contain the A-Test scores for each sample size

LARGEDIFFINDICATOR

The A-Test determines there is a large difference between two sets if the result is greater than 0.2 either side of the 0.5 line. Should this not be suitable, this can be changed here

AA_SIM_RESULTS_FILE

The name of the CSV file containing the simulation responses, if reading from a CSV file

AA_SIM_RESULTS_OBJECT

The name of the R object containing the simulation responses, if not reading from a CSV file

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"

GRAPHNAME

Used internally by the getATestResults method when producing graphs for multiple timepoints. Should not be set in function call.


spartan documentation built on May 2, 2019, 9:39 a.m.