diff options
author | Ken Kellner <ken.kellner@gmail.com> | 2014-05-08 20:15:10 -0400 |
---|---|---|
committer | Ken Kellner <ken.kellner@gmail.com> | 2014-05-08 20:15:10 -0400 |
commit | a5b1ced541951428ea105453f9dafa9414f0ccf6 (patch) | |
tree | 8eb7451695be4c911a81f0f96237fb1f726dbc70 /man | |
parent | f053d089f7b0988db8d76bfa13049f1270840f83 (diff) |
Update documentation.
Diffstat (limited to 'man')
-rw-r--r-- | man/ppcheck.Rd | 4 | ||||
-rw-r--r-- | man/whiskerplot.Rd | 2 |
2 files changed, 3 insertions, 3 deletions
diff --git a/man/ppcheck.Rd b/man/ppcheck.Rd index f8ef627..ce99a5c 100644 --- a/man/ppcheck.Rd +++ b/man/ppcheck.Rd @@ -5,7 +5,7 @@ \title{Posterior Predictive Checks for Bayesian Analyses fit in JAGS} \usage{ - postPredCheck(x, actual="fit", new="fit.new")} + pp.check(x, actual="fit", new="fit.new")} \arguments{ \item{x}{A simplejags object generated using the \code{jags} function} @@ -14,7 +14,7 @@ } \description{ - Generates a posterior predictive check plot for a JAGS analysis fit in simplejags(). + A simple interface for generating a posterior predictive check plot for a JAGS analysis fit in simplejags(), based on the posterior distributions of discrepency metrics specified by the user and calculated and returned by JAGS (for example, sums of residuals). The user supplies the name of the discrepancy metric calculated for the real data in the argument \code{actual}, and the corresponding discrepancy for data simulated by the model in argument \code{new}. The posterior distributions of the two parameters will be plotted in X-Y space and a Bayesian p-value calculated. } \author{ diff --git a/man/whiskerplot.Rd b/man/whiskerplot.Rd index 61bd24a..af4433e 100644 --- a/man/whiskerplot.Rd +++ b/man/whiskerplot.Rd @@ -10,7 +10,7 @@ \arguments{ \item{x}{A simplejags object} - \item{parameters}{A vector of names (as characters) of parameters to include in the plot. Parameter names must match parameters included in the model. When plotting non-scalar parameters with multiple values (e.g. \code{alpha} where \code{alpha} is a vector of length 2), the indexes of the parameter values must be specified (e.g. c('\code{alpha[1]}','\code{alpha[2]}') and not simply '\code{alpha}').} + \item{parameters}{A vector of names (as characters) of parameters to include in the plot. Parameter names must match parameters included in the model. Non-scalar parameters with multiple values (e.g. \code{alpha} where \code{alpha} is a vector of length 5) can be selected/subsetted (e.g. \code{alpha[1:3]}). Calling non-scalar parameters without subsetting (e.g. \code{alpha}) will plot all values of \code{alpha}.} \item{quantiles}{A vector with two values specifying the quantile values (lower and upper).} \item{zeroline}{If TRUE, a horizontal line at zero is drawn on the plot.} } |