Description Objects from the Class Slots Methods Author(s) References See Also Examples
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 can be created by calls of the form new("KDD.yearly.average", ...)
and kdd.yearly.average(...).
before.after
:Object of class "matrix"
with 2\times K+1 rows
and n columns: Each column gives the yearly average of the vectors of raw values (y_{i-K},…,y_{i+K}) of the time series for key days i occurring during a single year (K is the number of days considered after and before the key day, n is the number of years with key days in the data series and depends on keyday.threshold
).
year
:Object of class "numeric"
, vector of size n providing 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. if y_i≥ keyday.threshold
, then day i is a key day).
yearly.nb.keydays
:Object of class "numeric"
, vector of size n providing the number of key days at each year of the slot year
.
signature(x = "KDD.yearly.average")
: Extract one of the slots.
signature(x = "KDD.yearly.average")
: Prints slot names.
signature(object = "KDD.yearly.average")
: Prints all slots of the KDD object.
signature(object = "KDD.yearly.average")
: Prints summary characteristics of the KDD object.
Samuel Soubeyrand Samuel.Soubeyrand@avignon.inra.fr, Cindy E. Morris, E. Keith Bigg.
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.
KDD.yearly.average, KDD, kdd.from.raw.data, rain.site.6008
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 | 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"]
|
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.