From 057d6e22c945c154167be1bf532f64e5fe420328 Mon Sep 17 00:00:00 2001 From: helske Date: Sat, 10 Jul 2021 00:08:40 +0300 Subject: [PATCH] update docs --- .Rbuildignore | 1 + DESCRIPTION | 2 +- NAMESPACE | 1 + man/drownings.Rd | 12 +++++++----- man/{predict.Rd => predict.mcmc_output.Rd} | 5 ++++- 5 files changed, 14 insertions(+), 7 deletions(-) rename man/{predict.Rd => predict.mcmc_output.Rd} (96%) diff --git a/.Rbuildignore b/.Rbuildignore index 20d1730c..fb6972db 100644 --- a/.Rbuildignore +++ b/.Rbuildignore @@ -13,3 +13,4 @@ ^vignettes/psi_pf_experiments/.*\.sh$ ^vignettes/psi_pf_experiments/.*\.R$ ^\.github$ +slides_UseR2021 diff --git a/DESCRIPTION b/DESCRIPTION index b065737e..2b7317ef 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -3,7 +3,7 @@ Type: Package Title: Bayesian Inference of Non-Linear and Non-Gaussian State Space Models Version: 1.1.5 -Date: 2021-06-14 +Date: 2021-07-09 Authors@R: c(person(given = "Jouni", family = "Helske", diff --git a/NAMESPACE b/NAMESPACE index b516bf6d..c710e852 100644 --- a/NAMESPACE +++ b/NAMESPACE @@ -81,6 +81,7 @@ importFrom(stats,end) importFrom(stats,frequency) importFrom(stats,is.ts) importFrom(stats,logLik) +importFrom(stats,na.omit) importFrom(stats,qlogis) importFrom(stats,quantile) importFrom(stats,sd) diff --git a/man/drownings.Rd b/man/drownings.Rd index 89fd2650..9618e1d6 100644 --- a/man/drownings.Rd +++ b/man/drownings.Rd @@ -3,17 +3,19 @@ \docType{data} \name{drownings} \alias{drownings} -\title{Deaths by drowning in Finland in 1969-2014} +\title{Deaths by drowning in Finland in 1969-2019} \format{ -A time series object containing 46 observations. +A time series object containing 51 observations. } \source{ Statistics Finland \url{https://pxnet2.stat.fi/PXWeb/pxweb/en/StatFin/}. } \description{ -Dataset containing number of deaths by drowning in Finland in 1969-2014, -yearly average summer temperatures (June to August) and -corresponding population sizes (in hundreds of thousands). +Dataset containing number of deaths by drowning in Finland in 1969-2019, +corresponding population sizes (in hundreds of thousands), and +yearly average summer temperatures (June to August), based on simple +unweighted average of three weather stations: Helsinki (Southern Finland), +Jyväskylä (Central Finland), and Sodankylä (Northern Finland). } \examples{ data("drownings") diff --git a/man/predict.Rd b/man/predict.mcmc_output.Rd similarity index 96% rename from man/predict.Rd rename to man/predict.mcmc_output.Rd index 53ea1a85..7aeb9fa7 100644 --- a/man/predict.Rd +++ b/man/predict.mcmc_output.Rd @@ -2,6 +2,7 @@ % Please edit documentation in R/predict.R \name{predict.mcmc_output} \alias{predict.mcmc_output} +\alias{predict} \title{Predictions for State Space Models} \usage{ \method{predict}{mcmc_output}( @@ -29,7 +30,9 @@ posterior predictive checks. In this case, set argument \code{future} to \code{F \item{nsim}{Number of samples to draw.} -\item{future}{Default is \code{TRUE}, in which case predictions are future. +\item{future}{Default is \code{TRUE}, in which case predictions are for the future, +using posterior samples of (theta, alpha_T+1) i.e. the +posterior samples of hyperparameters and latest states. Otherwise it is assumed that \code{model} corresponds to the original model.} \item{seed}{Seed for RNG.}