Skip to content

Commit

Permalink
add some line breaks in the manual
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-buerkner committed Jul 23, 2015
1 parent c8c0f95 commit 051cac0
Show file tree
Hide file tree
Showing 8 changed files with 14 additions and 12 deletions.
4 changes: 2 additions & 2 deletions R/main.R
Original file line number Diff line number Diff line change
Expand Up @@ -8,8 +8,8 @@
#' the variables in the model. If not found in data, the variables are taken from \code{environment(formula)},
#' typically the environment from which \code{brm} is called.
#' @param family A vector of one or two character strings. The first string indicates the distribution of the dependent variable (the 'family'). Currently, the following families are supported:
#' \code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \code{"geometric"},
#' \code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
#' \code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \cr
#' \code{"geometric"}, \code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
#' The second string indicates the link function, which must be supported by the distribution of the dependent variable.
#' If not specified, default link functions are used. Further information is provided under 'Details'.
#' @param prior A named list of character strings specifing the prior distributions of the parameters. Further information
Expand Down
3 changes: 2 additions & 1 deletion R/s3.generics.R
Original file line number Diff line number Diff line change
Expand Up @@ -197,7 +197,8 @@ hypothesis <- function(x, hypothesis, class = "b", alpha = 0.05, ...)
#'
#' @examples
#' \dontrun{
#' fit_i <- brm(rating ~ treat + period + carry + (1|subject), data = inhaler, family = "cumulative")
#' fit_i <- brm(rating ~ treat + period + carry + (1|subject),
#' data = inhaler, family = "cumulative")
#'
#' #extract posterior samples of fixed effects
#' samples1 <- posterior.samples(fit_i, "b_")
Expand Down
2 changes: 1 addition & 1 deletion R/s3.methods.R
Original file line number Diff line number Diff line change
Expand Up @@ -405,7 +405,7 @@ print.brmshypothesis <- function(x, digits = 2, ...) {
#' \dontrun{
#' fit_e <- brm(count ~ log_Age_c + log_Base4_c * Trt_c + (1|patient) + (1|visit),
#' data = epilepsy, family = "poisson")
#' ## plot fixed effects as well as standard devations and correlations (if present) of random effects
#' ## plot fixed effects as well as standard devations of the random effects
#' plot(fit_e)
#' ## plot fixed effects only and combine the chains into one posterior
#' plot(fit_e, parameters = "^b_", combine = TRUE)
Expand Down
4 changes: 2 additions & 2 deletions man/brm.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ the variables in the model. If not found in data, the variables are taken from \
typically the environment from which \code{brm} is called.}

\item{family}{A vector of one or two character strings. The first string indicates the distribution of the dependent variable (the 'family'). Currently, the following families are supported:
\code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \code{"geometric"},
\code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
\code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \cr
\code{"geometric"}, \code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
The second string indicates the link function, which must be supported by the distribution of the dependent variable.
If not specified, default link functions are used. Further information is provided under 'Details'.}

Expand Down
4 changes: 2 additions & 2 deletions man/brm.data.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -16,8 +16,8 @@ the variables in the model. If not found in data, the variables are taken from \
typically the environment from which \code{brm} is called.}

\item{family}{A vector of one or two character strings. The first string indicates the distribution of the dependent variable (the 'family'). Currently, the following families are supported:
\code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \code{"geometric"},
\code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
\code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \cr
\code{"geometric"}, \code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
The second string indicates the link function, which must be supported by the distribution of the dependent variable.
If not specified, default link functions are used. Further information is provided under 'Details'.}

Expand Down
4 changes: 2 additions & 2 deletions man/brm.pars.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -17,8 +17,8 @@ the variables in the model. If not found in data, the variables are taken from \
typically the environment from which \code{brm} is called.}

\item{family}{A vector of one or two character strings. The first string indicates the distribution of the dependent variable (the 'family'). Currently, the following families are supported:
\code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \code{"geometric"},
\code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
\code{"gaussian"}, \code{"student"}, \code{"cauchy"}, \code{"multigaussian"}, \code{"binomial"}, \code{"bernoulli"}, \code{"categorical"}, \code{"poisson"}, \code{"negbinomial"}, \cr
\code{"geometric"}, \code{"gamma"}, \code{"exponential"}, \code{"weibull"}, \code{"cumulative"}, \code{"cratio"}, \code{"sratio"}, and \code{"acat"}.
The second string indicates the link function, which must be supported by the distribution of the dependent variable.
If not specified, default link functions are used. Further information is provided under 'Details'.}

Expand Down
2 changes: 1 addition & 1 deletion man/plot.brmsfit.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -28,7 +28,7 @@ Trace and density plots for MCMC samples using the \code{ggmcmc} package
\dontrun{
fit_e <- brm(count ~ log_Age_c + log_Base4_c * Trt_c + (1|patient) + (1|visit),
data = epilepsy, family = "poisson")
## plot fixed effects as well as standard devations and correlations (if present) of random effects
## plot fixed effects as well as standard devations of the random effects
plot(fit_e)
## plot fixed effects only and combine the chains into one posterior
plot(fit_e, parameters = "^b_", combine = TRUE)
Expand Down
3 changes: 2 additions & 1 deletion man/posterior.samples.Rd
Original file line number Diff line number Diff line change
Expand Up @@ -26,7 +26,8 @@ Currently there are methods for \code{brmsfit} objects.
}
\examples{
\dontrun{
fit_i <- brm(rating ~ treat + period + carry + (1|subject), data = inhaler, family = "cumulative")
fit_i <- brm(rating ~ treat + period + carry + (1|subject),
data = inhaler, family = "cumulative")

#extract posterior samples of fixed effects
samples1 <- posterior.samples(fit_i, "b_")
Expand Down

0 comments on commit 051cac0

Please sign in to comment.