plot_fitness_contour: Plot fitness function contour

plot_fitness_contourR Documentation

Plot fitness function contour

Description

Plot fitness function contour

Usage

plot_fitness_contour(
  .l_gof_values_,
  .l_params_,
  .gof_name_,
  .title_ = "",
  .param_x,
  .param_y,
  .scale_,
  .greys_,
  .legend_,
  .coloring_,
  .true_points_,
  .legend_x_t_llk_ = "0.15",
  .legend_x_t_sse_ = "0.15",
  .legend_x_nt_llk_ = "0.25",
  .legend_x_nt_sse_ = "0.25",
  .x_axis_lb_,
  .x_axis_ub_,
  .y_axis_lb_,
  .y_axis_ub_
)

Arguments

.l_gof_values_

List containing the goodness-of-fit (GOF) values corresponding to specific parameter(s) configurations.

.l_params_

List containing information about calibration parameters, including parameters' names, distributions, and boundaries.

.gof_name_

String specifying the GOF function name.

.param_x

String identifying the parameter plotted in the x-axis.

.param_y

String identifying the parameter plotted in the y-axis.

.scale_

String specifying colour-scale applied to the "ploty" contour. The options are "Blackbody", "Bluered", "Blues", "Cividis", "Earth", "Electric", "Greens", "Greys", "Hot", "Jet", "Picnic", "Portland", "Rainbow", "RdBu", "Reds", "Viridis" (default), "YlGnBu", and "YlOrRd".

.greys_

Logical for whether to use the "Greys" colour-scale. The .scale_ parameter overrides .greys_ if it was not NULL.

.legend_

Logical for whether to show the "plotly" contour colour-bar legend.

.coloring_

String specifying where the colour-scale set by the .scale_ parameter is applied on the "plotly" contour. The options are "fill", "heatmap", "none", and "lines". The "fill" option (default) paints the colour scales over the layers of the contour; the "heatmap" option employs a heatmap gradient colouring between each contour level; the "none" option paints no colours on the contour layers and uses a single colour with the contour lines; and the "lines" option applies the colour-scale on the contour lines.

.true_points_

Logical for whether to show "True values" on the plot.

.legend_x_t_llk_

Numeric (double) value specifying the x-axis relative location when "True values" are plotted and in "LLK" GOF plots.

.legend_x_t_sse_

Numeric (double) value specifying the x-axis relative location when "True values" are plotted and in "SSE" GOF plots.

.legend_x_nt_llk_

Numeric (double) value specifying the x-axis relative location when no "True values" are plotted and in "LLK" GOF plots.

.legend_x_nt_sse_

Numeric (double) value specifying the x-axis relative location when no "True values" are plotted and in "SSE" GOF plots.

.x_axis_lb_

Numeric (double) value specifying the lower bound of x-axis.

.x_axis_ub_

Numeric (double) value specifying the upper bound of x-axis.

.y_axis_lb_

Numeric (double) value specifying the lower bound of y-axis.

.y_axis_ub_

Numeric (double) value specifying the upper bound of y-axis.


W-Mohammed/calibrater documentation built on Oct. 14, 2023, 1:57 a.m.