plot_prediction_simple: Plot Simulated or Predicted _vs_ Observed performances

Description Usage Arguments Details Value

View source: R/plot_fclust.R

Description

Take two vectors corresponding to assemblage performances modelled by component clustering model, or assemblage performances predicted by cross-validation, and reference, observed assemblage performances, then plot modelled assemblage performances versus observed assemblage performances.

Usage

 1
 2
 3
 4
 5
 6
 7
 8
 9
10
11
plot_prediction_simple(Fx, Fy,
                       assMotif = rep(1, length(Fx)),
                       xylab     = c("Observed performance",
                                     "Modelled performance"),
                       xylim     = range(Fx),
                       figs      = rep(fsymbols()[1], length(Fx)),
                       cols      = rep(fcolours()[1], length(Fx)),
                       nbcl      = 1,
                       main      = "",
                       opt.mean  = "amean",
                       pvalue    = fpvalue())

Arguments

Fx, Fy

two numeric vector of length(Fx). The first vector contains assemblage performances to plot on x-axis. The second vector contains assemblage performances to plot on y-axis.

assMotif

an integer vector of length(Fx). The vector contains the labels of each assemblages. The labels are only used to plot the assemblage performances that share a same assembly motif with a same symbol and color. If it is omitted, all points are plotted using a same symbol and color. The default symbol and color is "red circle".

xylab

a vector of two strings. The strings are the labels of (x,y) axis.

xylim

a vector of two numerics. The numerics are extrem values of (x,y) axis.

figs, cols

two integer vectors of length(Fx). They contain the symbols and colours specific to each assembly motif recorded in assMotif.

nbcl

an integer. The integer indicates the number of clusters of components. The theoretical number m of assembly motif is m = 2^nbcl - 1. The number of clusters of components is only used as information written on the graph.

main

a string. The string is used as graph title.

opt.mean

a character equals to "amean" or "gmean". Switch to arithmetic formula if opt.mean = "amean". Switch to geometric formula if opt.mean = "gmean".

pvalue

a probability, used as threshold in the variance analysis. Then pvalue must be higher than 0 and lower than 1. Groups significantly different (at a p-value < pvalue) are then indicated by differents letters on the right of boxplots.

Details

All options are default values. If all options are omitted, the function plot Fy vs Fx, in red circle, with labels of x-axis xlab = "Observed performances" and y-axis ylab = "Simulated performances".

The two dashed blue lines are mean(Fy) and mean(Fx).

Value

Nothing. It is a procedure.


functClust documentation built on Dec. 2, 2020, 5:06 p.m.