Skip to content

Commit 4d60ed5

Browse files
committed
final updates
1 parent f5ceeee commit 4d60ed5

8 files changed

Lines changed: 26 additions & 20 deletions

File tree

BayesianTools/.Rbuildignore

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -3,4 +3,6 @@ _pkgdown\.yml$
33
^CRAN.md
44
tests/testthat/Rplots.pdf
55
vignettes/*.R
6-
vignettes/*.html
6+
vignettes/*.html
7+
^doc$
8+
^Meta$

BayesianTools/.gitignore

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
11
.Rproj.user
22
.Rhistory
33
.RData
4+
/doc/
5+
/Meta/

BayesianTools/R/BayesianTools.R

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
#' @keywords internal
22
#' @references
3-
#' vignette("Manual for the BayesianTools R package", package="BayesianTools")
3+
#' To access the vignettes, type vignette(package="BayesianTools")
44
#' @details A package with general-purpose MCMC and SMC samplers, as well as plots and diagnostic functions for Bayesian statistics, particularly for process-based models.
55
#'
66
#' The package contains 2 central functions, \code{\link{createBayesianSetup}}, which creates a standardized Bayesian setup with likelihood and priors, and \code{\link{runMCMC}}, which allows to run various MCMC and SMC samplers.

BayesianTools/man/BayesianTools-package.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

BayesianTools/man/WAIC.Rd

Lines changed: 1 addition & 1 deletion
Some generated files are not rendered by default. Learn more about customizing how changed files appear on GitHub.

BayesianTools/vignettes/BayesianTools.Rmd

Lines changed: 4 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -1,13 +1,14 @@
11
---
2-
title: "Bayesian Tools - General-Purpose MCMC and SMC Samplers and Tools for Bayesian Statistics"
2+
title: "Reference Manual for the BayesianTools R package"
33
output:
44
rmarkdown::html_vignette:
55
toc: true
66
vignette: >
7-
%\VignetteIndexEntry{Manual for the BayesianTools R package}
8-
\usepackage[utf8]{inputenc}
7+
%\VignetteIndexEntry{Reference Manual for the BayesianTools R package}
98
%\VignetteEngine{knitr::rmarkdown}
9+
%\VignetteEncoding{UTF-8}
1010
abstract: "The BayesianTools (BT) package supports model analysis (including sensitivity analysis and uncertainty analysis), Bayesian model calibration, as well as model selection and multi-model inference techniques for system models."
11+
date: "`r format(Sys.time(), '%d %B, %Y')`"
1112
editor_options:
1213
markdown:
1314
wrap: 72

BayesianTools/vignettes/InterfacingAModel.Rmd

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,10 @@ output:
55
toc: true
66
vignette: >
77
%\VignetteIndexEntry{Interfacing your model with R}
8-
\usepackage[utf8]{inputenc}
98
%\VignetteEngine{knitr::rmarkdown}
10-
abstract: "This tutorial discusses how to interface models written in other programming languages with R, so that they can be fit with BayesianTools"
9+
%\VignetteEncoding{UTF-8}
10+
abstract: "This tutorial discusses how to interface models written in other programming languages with R, so that they can be fit with BayesianTools <br>"
11+
date: "`r format(Sys.time(), '%d %B, %Y')`"
1112
author: Florian Hartig
1213
editor_options:
1314
chunk_output_type: console

BayesianTools/vignettes/PracticalTutorial.Rmd

Lines changed: 11 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -1,21 +1,21 @@
11
---
2-
title: "Fitting standard statistical models with the BayesianTools Package"
2+
title: "Practical examples fitting models with Bayesian Tools"
33
output:
44
rmarkdown::html_vignette:
55
toc: true
66
vignette: >
7-
%\VignetteIndexEntry{Statistical Models with the BayesianTools Package}
8-
\usepackage[utf8]{inputenc}
7+
%\VignetteIndexEntry{Practical examples fitting models with Bayesian Tools}
98
%\VignetteEngine{knitr::rmarkdown}
10-
abstract: "This vignette shows how to fit standard statistical models with the BayesianTools package"
9+
%\VignetteEncoding{UTF-8}
10+
abstract: "This vignette shows how to fit standard statistical models with the BayesianTools package"
1111
author: Florian Hartig
12+
date: "`r format(Sys.time(), '%d %B, %Y')`"
1213
editor_options:
1314
chunk_output_type: console
1415
---
1516

16-
1717
```{r global_options, include=FALSE}
18-
knitr::opts_chunk$set(fig.width=5, fig.height=5, warning=FALSE, cache = F)
18+
knitr::opts_chunk$set(fig.width=7, fig.height=7, warning=FALSE, cache = F)
1919
```
2020

2121
```{r, echo = F, message = F}
@@ -52,7 +52,7 @@ likelihood(par)
5252

5353
Creating the BayesianSetup by combining likelihood with uniform (flat) priors
5454

55-
```{r, message=F}
55+
```{r}
5656
library(BayesianTools)
5757
setup <- createBayesianSetup(likelihood = likelihood,
5858
lower = c(-100,-100,0),
@@ -62,8 +62,8 @@ setup <- createBayesianSetup(likelihood = likelihood,
6262

6363
Creating required setup for wrapper function runMCMC to start MCMCs
6464

65-
```{r}
66-
settings <- list(iterations = 10000, nrChains = 2)
65+
```{r, message=F}
66+
settings <- list(iterations = 10000, nrChains = 2, message = F)
6767
res <- runMCMC(bayesianSetup = setup, settings = settings)
6868
```
6969

@@ -133,13 +133,13 @@ likelihood(c(4,10,6,20,rep(0,11)))
133133

134134
Estimating the model
135135

136-
```{r, message=F}
136+
```{r}
137137
library(BayesianTools)
138138
setup <- createBayesianSetup(likelihood = likelihood,
139139
lower = c(-20,-50,0,0,rep(-100,11)),
140140
upper = c(20,50,50,100,rep(100,11)),
141141
names = c("a", "b", "err-sd", "RE-sd", 1:11))
142-
settings <- list(iterations = 30000, nrChains = 2)
142+
settings <- list(iterations = 30000, nrChains = 2, message = F)
143143
144144
res <- runMCMC(bayesianSetup = setup, settings = settings)
145145
```

0 commit comments

Comments
 (0)