sampling_frequency: Parameter Frequency and density Plot

Description Usage Arguments Value Examples

View source: R/sampling_frequency.R

Description

The 'sampling_frequency' function creates a frequency or density plot that depicts the sampling performed by irace across the iterations of the configuration process.

For categorical parameters a frequency plot is created, while for numerical parameters a histogram and density plots are created. The plots are shown in groups of maximum 9, the parameters included in the plot can be specified by setting the param_names argument.

Usage

1
2
3
4
5
6
sampling_frequency(
  irace_results,
  param_names = NULL,
  n = NULL,
  file_name = NULL
)

Arguments

irace_results

The data generated when loading the Rdata file created by irace

param_names

String vector, A set of parameters to be included (example: param_names = c("algorithm","alpha","rho","q0","rasrank"))

n

Numeric, for scenarios with large parameter sets, it selects a subset of 9 parameters. For example, n=1 selects the first 9 (1 to 9) parameters, n=2 selects the next 9 (10 to 18) parameters and so on.

file_name

String, file name to save plot. If there are more than 9 parameters, a pdf file extension is recommended as it allows to create a multi-page document. Otherwise, you can use the n argument of the function to generate the plot of a subset of the parameters. (example: "~/path/to/file_name.pdf")

Value

Frequency and/or density plot

Examples

1
2
3
4
sampling_frequency(iraceResults)
sampling_frequency(iraceResults, n = 2)
sampling_frequency(iraceResults, param_names = c("alpha"))
sampling_frequency(iraceResults, param_names = c("algorithm", "alpha", "rho", "q0", "rasrank"))

pabloOnate/iraceplot documentation built on Aug. 29, 2021, 2:32 a.m.