timeserplot: Produces a time series plot

View source: R/timeserplot.r

timeserplotR Documentation

Produces a time series plot

Description

Produces a time series plot, of variable 'y' as a function of 'x' by an observational unit factor.

Usage

timeserplot(
  data = data,
  y = y,
  x = x,
  obs.unit = obs.unit,
  factor1 = NA,
  factor2 = NA,
  only.lines = FALSE,
  ylab = NA,
  xlab = NA,
  linetype.lab = NA,
  factor2.line = TRUE,
  factor2.col = FALSE,
  col.lines = "black",
  max.y.all = NA,
  levels.i.want = FALSE,
  col.lev.i.want = FALSE
)

Arguments

data

a dataframe with at least tree columns representing the response variable ("y"), the main predictor variable ("x"), and a variable indicating the observational unit ("obs.unit").

y

a character giving the column name of the response variable or variable of interest.

x

a character giving the column name of the main predictor variable. Generally this variable is time.

obs.unit

a character giving the column name containing the info of the observational unit.

factor1

an optional character having the name of a column having a factor variable (e.g., treatment). The detault value is set to NULL.

factor2

an optional character having the name of a column having another factor variable (e.g., species). The detault value is set to NULL.

only.lines

a logic value if only lines, but not including dots, are going to be drwan in the plot. The detault value is set to FALSE.

ylab

Label for the Y-axis

xlab

Label for the X-axis

linetype.lab

is an optional string to be used as the title of the factor being represented by lines. It is only needed if factor1 and factor2 are defined. See example.

factor2.line

a logic value if the second factor, factor2, is going to be segregated according to the type of lines. The detault value is set to TRUE.

factor2.col

a logic value if the second factor, factor2, is going to be segregated according to the color of the lines only. The detault value is set to FALSE.

col.lines

A string specifying the single color to be used for the lines of the timeseries

max.y.all

A number representing the maximum level of Y-axis for all classes

levels.i.want

A vector having the levels for the factor under study

col.lev.i.want

A vector having the colors to be used for the factor under study

Details

Both 'y' and 'x' must be numeric variables, and the column representing the observational unit, must be a factor. This factor identifies the longitudinal context of the data, for instance, a student being measured on time. Besides, two more factors can be added to the plotting details, in order to represent the potential variability among them.

Value

This function returns a time series plot

Note

Please, uses the function with caution, and run first the examples to understand it better.

Author(s)

Christian Salas-Eljatib

References

Salas-Eljatib, C. 2021. Análisis de datos con el programa estadístico R: una introducción aplicada. Ediciones Universidad Mayor, Santiago, Chile. 170 p. https://eljatib.com/rlibro

Examples

data(ficdiamgr, package="datana")
df <- ficdiamgr
head(df)
str(df)
df$site<-as.factor(df$site)
df$species<-as.factor(df$species)
table(df$tree,df$species)
table(df$species,df$site)
#
timeserplot(df, y="dbh", x="time", obs.unit = "tree")
timeserplot(df, y="dbh", x="time", obs.unit = "tree", only.lines = TRUE)
#
## Otros ejemplos de uso de la funcion
timeserplot(df, y="dbh", x="time", obs.unit = "tree", col.lines = "blue",
only.lines = TRUE)
timeserplot(df, y="dbh", x="time", obs.unit = "tree", only.lines = FALSE)
#
timeserplot(df, y="dbh", x="time", obs.unit = "tree", factor1="site")
timeserplot(df, y="dbh", x="time", obs.unit = "tree", factor1="site",
factor2= "species")
timeserplot(df, y="dbh", x="time", obs.unit = "tree", factor1="site",
 factor2= "species", factor2.col = TRUE, only.lines = TRUE)

datana documentation built on June 13, 2025, 1:11 a.m.