aa_sampleSizeSummary: Determines the median and maximum A-Test score observed for...

Description Usage Arguments

View source: R/aleatory_analysis.R

Description

This takes each sample size to be examined in turn, and iterates through all the subsets, determining the median and maximum A-Test score observed for each sample size. A CSV file is created summarising the median and maximum A-Test scores for all sample sizes, named as stated in parameter SUMMARYFILENAME. If doing this analysis over multiple timepoints, the timepoint will be appended to the filename given in SUMMARYFILENAME.

Usage

1
2
3
aa_sampleSizeSummary(FILEPATH, SAMPLESIZES, MEASURES, SUMMARYFILENAME,
  ATESTRESULTS_FILE = NULL, ATESTRESULTS_OBJECT = NULL,
  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.

SUMMARYFILENAME

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

ATESTRESULTS_FILE

The name of a CSV file containing the A-Test results calculated by aa_getATestResults, if reading from a CSV file.

ATESTRESULTS_OBJECT

The name of an R object containing the A-Test results calculated by aa_getATestResults, 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"

check_done

If multiple timepoints, whether the input has been checked


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