Class KDD (Key Day Dataset) used as argument in FeedbackTS functions for the analysis of fragmented time directionality and feedback.
Objects from the Class
Objects can be created by calls of the form new("KDD", ...), kdd.from.raw.data(...) and kdd(...).
Slots
before.after:
Object of class "matrix" with 2\times K+1 rows
and n columns: Each column gives the raw values y_{i-K},…,y_{i+K} of the time series, where i is the date of the key day, K is the number of days considered after and before the key day, n is the number of key days in the data series (depends on keyday.threshold).
date:
Object of class "character", vector of size n providing the dates of the key days in format yyyy.mm.dd.
year:
Object of class "numeric", vector of size n providing the years during which the key days occurred.
day:
Object of class "numeric", vector of size n providing for each key day the number of days since the beginning of the data series.
keyday.threshold:
Object of class "numeric" providing the threshold value above which a day is considered as a key day (i.e. if y_i≥ keyday.threshold, then day i is a key day).
Methods
[<-
signature(x = "KDD"): Change one of the slots.
[
signature(x = "KDD"): Extract one of the slots.
names
signature(x = "KDD"): Prints slot names.
show
signature(object = "KDD"): Prints all slots of
the KDD object.
summary
signature(object = "KDD"): Prints summary
characteristics of the KDD object.
Soubeyrand, S., Morris, C. E. and Bigg, E. K. (2014). Analysis of fragmented time directionality in time series to elucidate feedbacks in climate data. Environmental Modelling and Software 61: 78-86.
showClass("KDD")
#### load data for site 6008 (Callagiddy station)
data(rain.site.6008)
#### build a KDD object from raw data (site 6008: Callagiddy station)
## using a threshold value equal to 25
KDD=kdd.from.raw.data(raw.data=rain.site.6008,keyday.threshold=25,nb.days=20,
col.series=5,col.date=c(2,3,4),na.rm=TRUE,filter=NULL)
## summary of the object
summary(KDD)
## names of the object
names(KDD)
slotNames(KDD)
## show attributes of the object
KDD["before.after"][,1:5]
KDD["date"]
KDD["keyday.threshold"]
## change keyday threshold
KDD["keyday.threshold"]=50
Results
R version 3.3.1 (2016-06-21) -- "Bug in Your Hair"
Copyright (C) 2016 The R Foundation for Statistical Computing
Platform: x86_64-pc-linux-gnu (64-bit)
R is free software and comes with ABSOLUTELY NO WARRANTY.
You are welcome to redistribute it under certain conditions.
Type 'license()' or 'licence()' for distribution details.
R is a collaborative project with many contributors.
Type 'contributors()' for more information and
'citation()' on how to cite R or R packages in publications.
Type 'demo()' for some demos, 'help()' for on-line help, or
'help.start()' for an HTML browser interface to help.
Type 'q()' to quit R.
> library(FeedbackTS)
Error in library(FeedbackTS) : there is no package called 'FeedbackTS'
Execution halted