sc.order: Plot Model selection Criteria

Description Usage Arguments Value Examples

View source: R/ic_order_function.R

Description

Plots the selection criteria of the tested models in ascending order.

Usage

1
2
3
4
5
6
7
8
sc.order(
  input = getwd(),
  mrun = NULL,
  number = NULL,
  colour.par = NULL,
  save.output = NULL,
  ...
)

Arguments

input

Either a string containing the directory which holds the "FAMoS-Results" folder or a matrix containing the tested models along with the respective selection criteria. Default to getwd().

mrun

A string giving the number of the corresponding FAMoS run, e.g "004". If NULL (default), all FAMoS runs in the folder will be used for evaluation.

number

Specifies the number of models that will be plotted. If NULL (default), all tested models will be used for plotting.

colour.par

The name of a model parameter. All models containing this parameter will be coloured red. Default to NULL.

save.output

A string containing the location and name under which the figure should be saved (format is .pdf). Default to NULL.

...

Additional parameters that will be passed on to barplot.

Value

Barplot showing the ordered selection criteria of the tested models. Also returns a data frame containing each unique tested model with its best selection criteria.

Examples

1
2
3
#plot the selection criteria
sc.order(input = famos.run)
sc.order(input = famos.run, colour.par = "p1")

FAMoS documentation built on April 14, 2020, 5:43 p.m.