longitudinalData (version 2.4.7)

windowsCut: ~ Function: windowsCut ~

Description

windowsCut prepare an object ParWindows according to its arguments.

Usage

windowsCut(x, addLegend = TRUE,closeScreen=TRUE)

Value

An object of class ParWindows.

Arguments

x

[numeric] or [couple(numeric)]: x is used to calculate the fields nbCol and nbRow of the object ParWindows. If x is a couple, then x[1] is nbRow and x[2] is nbCol. If x is a single number (the number of plot that should be display), nbCol and nbRow parameters are calculate consequently (see detail).

addLegend

[logical]: If addLegendis true, an extra space is reserved on the top of the screen to print the legend.

closeScreen

[logical]: Some function need to add details on a graph. This option let them call a plot function that will not call a close.screen on exit, so the graph will be modifiable.

Author

Christophe Genolini
1. UMR U1027, INSERM, Université Paul Sabatier / Toulouse III / France
2. CeRSM, EA 2931, UFR STAPS, Université de Paris Ouest-Nanterre-La Défense / Nanterre / France

Details

If x is a number of variable, the column and row number are estimate according to the formula nbCol <- ceiling(sqrt(x)) and nbRow <- ceiling(x/nbCol).

References

[1] C. Genolini and B. Falissard
"KmL: k-means for longitudinal data"
Computational Statistics, vol 25(2), pp 317-328, 2010

[2] C. Genolini and B. Falissard
"KmL: A package to cluster longitudinal data"
Computer Methods and Programs in Biomedicine, 104, pp e112-121, 2011

Examples

  ### Simple cut with no space for legent
  windowsCut(3,FALSE)
  windowsCut(4,FALSE)
  windowsCut(5,FALSE)

  ### Simple cut with legend
  windowsCut(5)