Skip to content

Commit

Permalink
update installation instructions in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
paul-buerkner committed Jul 23, 2015
1 parent 051cac0 commit facbf64
Show file tree
Hide file tree
Showing 2 changed files with 20 additions and 1 deletion.
9 changes: 9 additions & 0 deletions README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -63,10 +63,19 @@ help(brm)

# How to install brms

To install the latest release version from CRAN use

```{r install_brms, eval=FALSE}
install.packages("brms")
```

The current developmental version can be downloaded from github via

```{r install_brms2, eval=FALSE}
library(devtools)
install_github("paul-buerkner/brms")
```

Because <b>brms</b> is based on Stan, a C++ compiler is required. The program Rtools (available on https://cran.r-project.org/bin/windows/Rtools/) comes with a C++ compiler for Windows. On Mac, you should use Xcode. We recommend to install rstan (available on CRAN) before installing <b>brms</b>. For further instructions see https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started.

<!-- Before you will be able to actually fit bayesian models with brms, the package rstan has to be installed manually, as it is not on CRAN, yet. First, you need a C++ compiler. See https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started#prerequisites for instructions on how to get one. Second, install rstan by running the following R code (the number behind 'j' in the first line corresponds to the number of cores to use for the installation). This may take a few minutes and you should restart R after the installation.
Expand Down
12 changes: 11 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -30,6 +30,7 @@ summary(fit)
#> Data: epilepsy (Number of observations: 236)
#> Samples: 2 chains, each with n.iter = 2000; n.warmup = 500; n.thin = 1;
#> total post-warmup samples = 3000
#> WAIC: Not computed
#>
#> Random Effects:
#> ~patient (Number of levels: 59)
Expand Down Expand Up @@ -69,7 +70,7 @@ For a complete list of methods to apply on <b>brms</b> models see
methods(class = "brmsfit")
#> [1] fixef formula hypothesis ngrps nobs par.names
#> [7] plot posterior.samples predict print ranef summary
#> [13] VarCorr
#> [13] VarCorr WAIC
#> see '?methods' for accessing help and source code
```

Expand All @@ -82,10 +83,19 @@ help(brm)
How to install brms
===================

To install the latest release version from CRAN use

``` r
install.packages("brms")
```

The current developmental version can be downloaded from github via

``` r
library(devtools)
install_github("paul-buerkner/brms")
```

Because <b>brms</b> is based on Stan, a C++ compiler is required. The program Rtools (available on <https://cran.r-project.org/bin/windows/Rtools/>) comes with a C++ compiler for Windows. On Mac, you should use Xcode. We recommend to install rstan (available on CRAN) before installing <b>brms</b>. For further instructions see <https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started>.

<!-- Before you will be able to actually fit bayesian models with brms, the package rstan has to be installed manually, as it is not on CRAN, yet. First, you need a C++ compiler. See https://github.com/stan-dev/rstan/wiki/RStan-Getting-Started#prerequisites for instructions on how to get one. Second, install rstan by running the following R code (the number behind 'j' in the first line corresponds to the number of cores to use for the installation). This may take a few minutes and you should restart R after the installation.
Expand Down

0 comments on commit facbf64

Please sign in to comment.