KDD.yearly.average-class {FeedbackTS} | R Documentation |
Class "KDD.yearly.average"
Description
Class KDD.yearly.average (yearly average of a 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.yearly.average", ...)
and kdd.yearly.average(...).
Slots
before.after
:Object of class
"matrix"
withrows and
columns: Each column gives the yearly average of the vectors of raw values
of the time series for key days
occurring during a single year (
is the number of days considered after and before the key day,
is the number of years with key days in the data series and depends on
keyday.threshold
).year
:Object of class
"numeric"
, vector of sizeproviding the years during which the key days occurred.
keyday.threshold
:Object of class
"numeric"
providing the threshold value above which a day is considered as a key day (i.e. ifkeyday.threshold
, then dayis a key day).
yearly.nb.keydays
:Object of class
"numeric"
, vector of sizeproviding the number of key days at each year of the slot
year
.
Methods
- [
signature(x = "KDD.yearly.average")
: Extract one of the slots.- names
signature(x = "KDD.yearly.average")
: Prints slot names.- show
signature(object = "KDD.yearly.average")
: Prints all slots of the KDD object.- summary
signature(object = "KDD.yearly.average")
: Prints summary characteristics of the KDD object.
Author(s)
Samuel Soubeyrand Samuel.Soubeyrand@avignon.inra.fr, Cindy E. Morris, E. Keith Bigg.
References
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.
See Also
KDD.yearly.average, KDD, kdd.from.raw.data, rain.site.6008
Examples
showClass("KDD.yearly.average")
#### 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)
#### build the yearly average of KDD
KDD2=kdd.yearly.average(KDD)
## summary of the object
summary(KDD2)
## names of the object
names(KDD2)
slotNames(KDD2)
## show attributes of the object
KDD2["before.after"][,1:5]
KDD2["year"]
KDD2["keyday.threshold"]