Skip to content

Installing TruncExpFam

Waldir Leoncio edited this page Feb 4, 2021 · 1 revision

Installing the stable version of the package

TruncExpFam is currently under development and a stable version is yet to be released.

Installing the development version of the package

If you don't have a local copy of the repository

You can install the development version of TruncExpFam on any R session by issuing the following command from an R session:

remotes::install_github("ocbe-uio/TruncExpFam", ref="develop")

If the command above fails, make sure you have the "remotes" package installed. You can also add , dependencies=TRUE to the function above to make sure you have all package dependencies installed

If you already have a local copy of the repository

First, you start an R session from the root of the package directory. Then, make sure you have the devtools package installed and loaded:

install.packages("devtools")
library(devtools)

Then, you can install a new version of the package by issuing the following from an R session:

install()

⚠️ One recommended action to perform before installing a new build of the package is to increment the build version in the DESCRIPTION file. The build version is the 4-digit number that comes after 0.0.0 (currently, 9001). This way, after you use install() you can use

packageVersion("TruncExpFam")

to be sure you're using the updated version.

You may also need to reload the package with library(TruncExpFam) after installing.

Bonus: you can use check() to see if there are any structural problems with the package (syntax errors, faulty documentation, etc.).