Coxmos (version 1.1.2)

plot_time.list: Time consuming plot.

Description

Produces a visual representation, using ggplot2, of the computational time consumed by each model encapsulated within the provided list of Coxmos models. This visualization aids in the comparative assessment of computational efficiency across different models.

Usage

plot_time.list(
  lst_models,
  x.text = "Method",
  y.text = NULL,
  legend.title = "Method",
  x.text.size = 12,
  txt.x.angle = 0,
  legend.text.size = 12,
  value.text.size = 4,
  value.nudge.y = 0.005
)

Value

A 'ggplot2' bar plot object.

Arguments

lst_models

List of Coxmos models. Each Coxmos object has the attribute time measured in minutes (cross-validation models could be also added to this function).

x.text

Character. X axis title (default: "Method").

y.text

Character. Y axis title. If y.text = NULL, then y.text = "Time (mins)" (default: NULL).

legend.title

Character. Title of the legend (default: "Method").

x.text.size

Numeric. Size of the text for the x-axis labels (default: 12).

txt.x.angle

Numeric. Angle of the text for the x-axis labels (default: 0).

legend.text.size

Numeric. Size of the text for the legend labels (default: 12).

value.text.size

Numeric. Size of the text for the values displayed on the bars (default: 4).

value.nudge.y

Numeric. Vertical adjustment for the text of the values displayed on the bars (default: 0.005).

Author

Pedro Salguero Garcia. Maintainer: [e-mail]

Details

The plot_time.list function objective is to offer a clear and concise visual representation of the computational time expended by each model during its execution.

The function expects a list of Coxmos models, each of which should inherently possess a time attribute indicating the computational time it consumed. This time attribute is then extracted, aggregated, and visualized in a bar plot format. The function is versatile enough to handle both individual models and cross-validation models, summing up the computational times in the latter case to provide an aggregate view.

The resultant plot is generated using the 'ggplot2' package, ensuring a high-quality and interpretable visualization. The Y-axis of the plot represents the computational time, typically in minutes, while the X-axis enumerates the different models. The function also offers customization options for axis labels, legend title and text size, and the size and position of the values displayed on the bars, ensuring that the resultant plot aligns with the user's preferences and the intended audience's expectations.

Examples

data("X_proteomic")
data("Y_proteomic")
X <- X_proteomic[1:30,1:30]
Y <- Y_proteomic[1:30,]
coxSW.model <- coxSW(X, Y, x.center = TRUE, x.scale = TRUE)
coxEN.model <- coxEN(X, Y, x.center = TRUE, x.scale = TRUE)
lst_models = list("coxSW" = coxSW.model, "coxEN" = coxEN.model)
plot_time.list(lst_models, x.text = "Method", legend.title = "Model Method",
               x.text.size = 14, txt.x.angle = 90, legend.text.size = 14,
               value.text.size = 5, value.nudge.y = 0.2)