Skip to content

Commit

Permalink
more detailed installation intructions in README (#54)
Browse files Browse the repository at this point in the history
  • Loading branch information
danielturek authored May 23, 2024
1 parent 0b42fa7 commit c2bb7a5
Showing 1 changed file with 16 additions and 6 deletions.
22 changes: 16 additions & 6 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,14 +12,24 @@ See the [nimble user manual](https://r-nimble.org/html_manual/cha-mcmc.html#subs

Additional information about the `nimble`package itself is available at the [nimble website](https://r-nimble.org/).

<!--
The nimbleHMC package must be used with nimble version XXXX or
higher. To check the current version number of nimble use `packageVersion("nimble")`.
-->

### Package Requirements

`nimbleHMC` must be used with version `1.0.0` or higher of the `nimble` package.
### Installation and Package Requirements

Use of `nimbleHMC` requires installation of the core `nimble` package. Detailed instructions for installing `nimble` are available in the [`nimble` package README](https://github.com/nimble-dev/nimble/blob/devel/README.md).

`nimbleHMC` must be used with version `1.0.0` or higher of `nimble`, or the latest version available on CRAN. To check the version number of the currently installed version of `nimble`, use:

```r
packageVersion("nimble")
```

The `nimbleHMC` package itself can be installed directly from CRAN, using:

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


<!--
library(remotes)
Expand Down

0 comments on commit c2bb7a5

Please sign in to comment.