# Part of the rstanarm package for estimating model parameters
# Copyright (C) 2015, 2016, 2017 Trustees of Columbia University
#
# This program is free software; you can redistribute it and/or
# modify it under the terms of the GNU General Public License
# as published by the Free Software Foundation; either version 3
# of the License, or (at your option) any later version.
#
# This program is distributed in the hope that it will be useful,
# but WITHOUT ANY WARRANTY; without even the implied warranty of
# MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
# GNU General Public License for more details.
#
# You should have received a copy of the GNU General Public License
# along with this program; if not, write to the Free Software
# Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston, MA 02110-1301, USA.
#' Example model
#'
#' A model for use in \pkg{rstanarm} examples.
#'
#' @name example_model
#' @format Calling \code{example("example_model")} will run the model in the
#' Examples section, below, and the resulting stanreg object will then be
#' available in the global environment. The \code{chains} and \code{iter}
#' arguments are specified to make this example be small in size. In practice,
#' we recommend that they be left unspecified in order to use the default
#' values (4 and 2000 respectively) or increased if there are convergence
#' problems. The \code{cores} argument is optional and on a multicore system,
#' the user may well want to set that equal to the number of chains being
#' executed.
#'
#' @seealso \code{\link[lme4]{cbpp}} for a description of the data.
#' @examples
#' if (.Platform$OS.type != "windows" || .Platform$r_arch != "i386") {
#' example_model <-
#' stan_glmer(cbind(incidence, size - incidence) ~ size + period + (1|herd),
#' data = lme4::cbpp, family = binomial, QR = TRUE,
#' # this next line is only to keep the example small in size!
#' chains = 2, cores = 1, seed = 12345, iter = 1000, refresh = 0)
#' example_model
#' }
NULL
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.