1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
|
# Part of the rstanarm package for estimating model parameters
# Copyright (C) 2017 Sam Brilleman
#
# 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 joint longitudinal and time-to-event model
#'
#' A model for use in the \pkg{rstanarm} examples related to \code{\link{stan_jm}}.
#'
#' @name example_jm
#' @format Calling \code{example("example_jm")} will run the model in the
#' Examples section, below, and the resulting stanmvreg 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 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.
#'
#' @examples
#' # set.seed(123)
#' if (.Platform$OS.type != "windows" || .Platform$r_arch !="i386")
#' example_jm <-
#' stan_jm(formulaLong = logBili ~ year + (1 | id),
#' dataLong = pbcLong[1:101,],
#' formulaEvent = survival::Surv(futimeYears, death) ~ sex + trt,
#' dataEvent = pbcSurv[1:15,],
#' time_var = "year",
#' # this next line is only to keep the example small in size!
#' chains = 1, seed = 12345, iter = 100, refresh = 0)
#'
#'
NULL
|
