tsl_names_get: Get Time Series Names from a Time Series Lists

View source: R/tsl_names.R

tsl_names_getR Documentation

Get Time Series Names from a Time Series Lists

Description

A time series list has two sets of names: the names of the list items (as returned by names(tsl)), and the names of the contained zoo objects, as stored in their attribute "name". These names should ideally be the same, for the sake of data consistency. This function extracts either set of names,

Usage

tsl_names_get(tsl = NULL, zoo = TRUE)

Arguments

tsl

(required, list) Time series list. Default: NULL

zoo

(optional, logical) If TRUE, the attributes "name" of the zoo objects are returned. Default: TRUE

Value

list

See Also

Other tsl_management: tsl_burst(), tsl_colnames_clean(), tsl_colnames_get(), tsl_colnames_prefix(), tsl_colnames_set(), tsl_colnames_suffix(), tsl_count_NA(), tsl_diagnose(), tsl_handle_NA(), tsl_join(), tsl_names_clean(), tsl_names_set(), tsl_names_test(), tsl_ncol(), tsl_nrow(), tsl_repair(), tsl_subset(), tsl_time(), tsl_to_df()

Examples

#initialize a time series list
tsl <- tsl_initialize(
  x = fagus_dynamics,
  name_column = "name",
  time_column = "time"
)


#get names of zoo objects
tsl_names_get(
  tsl = tsl,
  zoo = TRUE
)

#get list names only
tsl_names_get(
  tsl = tsl,
  zoo = FALSE
  )

#same as
names(tsl)

distantia documentation built on April 4, 2025, 5:42 a.m.