diff --git a/README.Rmd b/README.Rmd index 73380e2d..0bf8cce9 100644 --- a/README.Rmd +++ b/README.Rmd @@ -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}