lhc_graphMeasuresForParameterChange: Generates parameter/measure plot for each pairing in the...

Description Usage Arguments

Description

Produces a graph for each parameter, and each output measure, showing the simulation output achieved when that parameter was assigned that value. Eases identification of any non-linear effects.

Usage

1
2
3
4
5
lhc_graphMeasuresForParameterChange(FILEPATH, PARAMETERS, MEASURES,
  MEASURE_SCALE, CORCOEFFSOUTPUTFILE, LHCSUMMARYFILENAME,
  OUTPUT_TYPE = c("PDF"), TIMEPOINTS = NULL, TIMEPOINTSCALE = NULL,
  GRAPHTIME = NULL, check_done = FALSE,
  corcoeffs_output_object = NULL, lhc_summary_object = NULL)

Arguments

FILEPATH

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

PARAMETERS

Array containing the names of the parameters of which parameter samples will be generated

MEASURES

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

MEASURE_SCALE

Scale in which each of the output responses is measured. Used to label plots

CORCOEFFSOUTPUTFILE

File produced by spartan containing the Partial Rank Correlation Coefficients for each parameter/measure pairing

LHCSUMMARYFILENAME

Name of the LHC Summary file to be generated. Contains each parameter set alongside the result gained when the simulation was run under that criteria.

OUTPUT_TYPE

Type of graph to plot. Can be PDF, PNG, TIFF, BMP, etc, all formats supported by ggplot2

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"

GRAPHTIME

The timepoint being processed, if any. NULL if not.

check_done

For multiple timepoints, whether input has been checked

corcoeffs_output_object

Correlation coefficients can be input as an R object as well as CSV file. In this case, CORCOEFFSOUTPUTFILE will be NULL

lhc_summary_object

If not specified in a CSV file, results can be specified in an R object. In this case LHCSUMMARYFILENAME will be NULL


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