NGSSEML (version 2.1)

PlotF: Plot Function

Description

The function PlotF gives graphs with smoothed/filtered estimates of the latent states.

Usage

PlotF(formula, data,na.action="na.omit",pz=NULL,nBreaks=NULL,
plotYt=TRUE,axisxdate=NULL,transf=1,model="Poisson",posts,Proc="Smooth",
Type="Marg",distl="PRED",a0=0.01,b0=0.01,ci=0.95,startdate=NULL,enddate=NULL,
Freq=NULL,Typeline='l',cols=c("black","blue","lightgrey"),xxlab="t",
yylab=expression(paste(hat(mu)[t])),xxlim=NULL,yylim=NULL,Lty=c(1,2,1),
Lwd=c(2,2,2),Cex=0.68)

Arguments

formula

an object of class "formula" (or one that can be coerced to that class): a symbolic description of the model to be fitted.

data

a data frame containing the variables in the model. The variables are: - the time series of interest Yt (first column of the data frame). the explanatory time series to be inserted in the model. - Xt must be always specified as a matrix of order n by p (after Yt). - the explanatory time series to be inserted in the mean of volatility model. Zt must be always specified as a matrix of order n by p (after Xt). - a censoring indicator of the event (a vector), only for the PEM. If the model is the PEM, put the variable Event in the secon column of tha data frame after Yt, and he explanatory time series after the variable Event. The value 1 indicates failure.

na.action

a function which indicates what should happen when the data contain NAs. The default is set by the na.action setting of options, and is na.fail if that is unset. Optional argument.

pz

the number of the explanatory time series to be inserted in the mean of volatility model. Default: NULL. Optional argument.

nBreaks

the number of breaks used to build a vector with the interval limits, only for the PEM. Optional argument.

transf

This argument allows the user to apply a transformation (exponentiation) in the estimates of the latent states. For example, the inverse transformation, i. e., transf = -1. The default value is 1. Optional argument.

model

the chosen model for the observations. The options are: Poisson, Normal, Gamma, Weibull, Generalized Gamma, Laplace, GED and PEM models.

posts

A sample or an estimate of the static parameters.

plotYt

If true, the time series Yt is inserted in the plot. The default value is TRUE. Optional argument.

axisxdate

a date vector for the x-axis can be specified in this function. The default value is NULL. Optional argument.

Proc

the latent states distribution to be returned. There are 2 options: the smoothed ("Smooth") and filtering ("Filter") distributions.

Type

the chosen distribution of the lantent states. There are 2 options: conditional ("Cond") on the static parameters and marginal ("Marg"). The default is "Marg".

distl

the chosen distribution of the lantent states in the filtering procedure. There are 2 options: the one-step ahead ("PRED") and filtering ("Filter") distributions. The default is "PRED".

a0

the shape parameter of the initial Gamma distribution. Optional argument. Default: a0=0.01.

b0

the scale parameter of the initial Gamma distribution. Optional argument. Default: b0=0.01.

ci

the nominal level of confidence interval for the parameters. Optional argument. Default: ci=0.95.

startdate

If the argument axisxdate is not NULL, it is necessary to specify a start date. Optional argument.

enddate

If the argument axisxdate is not NULL, it is necessary to specify an end date. Optional argument.

Freq

If the argument axisxdateis not NULL, it is necessary to specify a frequency of the data. Optional argument.

Typeline

the type of plot should be drawn. Possible types are "p" for points, "l" for lines, "s" for stair steps and etc. Optional argument.

cols

You can specify colors in the graph. Optional argument.

xxlab

a title for the x-axis. Optional argument.

yylab

a title for the y-axis. Optional argument.

xxlim

a numeric vector with limits for the x-axis. Optional argument.

yylim

a numeric vector with limits for the y-axis. Optional argument.

Lty

A line type. Optional argument.

Lwd

Line width relative to the default (default=1).2 is twice as wide. Optional argument.

Cex

number indicating the amount by which plotting text and symbols should be scaled relative to the default. 1=default, 1.5 is 50% larger, 0.5 is 50% smaller, etc. . Optional argument.

Value

graph

This function returns an graph with smoothed or filtered estimates of the latent states.

Details

Typical usages are

PlotF(YYtm~Trend+CosAnnual+SinAnnual+CosSemiAnnual+SinSemiAnnual,
data=data.frame(Ytm,Xtm),model="Poisson",StaPar=estopt,axisxdate=x,Proc="Smooth",
Type="Cond",distl="FILTER",a0=0.01,b0=0.01,ci=0.95,posts=estopt,
startdate="1970/01/01",enddate="1983/12/31",Freq="months",
cols=c("black","blue","lightgrey"),xxlab="t",yylab="Yt",yylim=c(0,15),
Lty=c(1,2,1),Lwd=c(2,2,2),Cex=0.68

References

Gamerman, D., Santos, T. R., and Franco, G. C. (2013). A Non-Gaussian Family of State-Space Models with Exact Marginal Likelihood. Journal of Time Series Analysis, 34(6), 625-645.

Santos T. R., Gamerman, D., Franco, G. C. (2017). Reliability Analysis via Non-Gaussian State-Space Models. IEEE Transactions on Reliability, 66, 309-318.

See Also

FilteringF SmoothingF ngssm.bayes ngssm.mle

Examples

# NOT RUN {
###############################################################################
## Petro data:
library(NGSSEML)
#### Inputs: 
data(Rt)
Ytm=Rt$Rt
Date=Rt$Date
Xtm=NULL
Ztm=NULL
model="GED"
LabelParTheta=c("W","nu")
StaPar=c(0.9,1)
p=length(StaPar)
nn=length(Ytm)
a0=0.01
b0=0.01
pointss= 4   ### points
nsamplex=25 ## Sampling posterior
ci=0.95       # Cred. level
fitbayes<-ngssm.bayes(Ytm~1,data=data.frame(Ytm),model=model,pz=NULL,
StaPar=StaPar,a0=a0,b0=b0,prw=c(1,1),
prnu=c(0.01,0.01),ci=ci,pointss=pointss,nsamplex=nsamplex,
postplot=FALSE,contourplot=FALSE,LabelParTheta=LabelParTheta)
#postaux<-fitbayes$samplepost[,]
posts<-fitbayes$samplepost
############
#Smoothing:
############
#PlotF function:
PlotF(Ytm~1,data=data.frame(Ytm),model=model,pz=NULL,plotYt=FALSE,
transf=-0.5,Proc="Smooth",Type="Marg",distl="PRED",a0=a0,b0=b0,
ci=ci,posts=posts,startdate=NULL,enddate=NULL,Freq="days",Typeline='l',
cols=c("black","blue","lightgrey"),xxlab="t",yylab=expression(paste(hat(sigma)[t])),
yylim=c(0.02,0.10),Lty=c(1,2,1),Lwd=c(2,2,2),Cex=0.68)
# dev.new()
###############################################################################
# }