Skip to content

Commit

Permalink
Update installation instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
jamesmbaazam committed Jun 3, 2024
1 parent 4375575 commit 60f1787
Showing 1 changed file with 11 additions and 1 deletion.
12 changes: 11 additions & 1 deletion README.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -46,12 +46,22 @@ _{{ packagename }}_ is developed at the [Centre for the Mathematical Modelling o

The latest development version of the _{{ packagename }}_ package can be installed via

```{r install_pkg, include=TRUE,eval=FALSE}
```{r install_with_remotes, include=TRUE,eval=FALSE}
# check whether {remotes} is installed
if (!require("remotes")) install.packages("remotes")
remotes::install_github("{{ gh_repo }}")
```

If this fails, try using the `pak` R package via

```{r install_with_pak, include=TRUE,eval=FALSE}
# check whether {pak} is installed
if (!require("pak")) install.packages("pak")
pak::pak("{{ gh_repo }}")
```

If both of these options fail, please [file an issue](https://github.com/epiverse-trace/epichains/issues) with a full log of the error messages. Here is an [example of an issue reporting an installation failure](https://github.com/epiverse-trace/epichains/issues/262). This will help us to improve the installation process.

To load the package, use

```{r load_pkg, eval=TRUE}
Expand Down

0 comments on commit 60f1787

Please sign in to comment.