diff --git a/README.md b/README.md index 498424ce4799af66dc47328b5e2086bd18896420..a5a9187f22cb57d7403ce65b695a303c0562ab45 100644 --- a/README.md +++ b/README.md @@ -2,23 +2,34 @@ ## Installation +* method A: To install the latest version of HTRfit, run the following in your R console : - ``` if (!requireNamespace("remotes", quietly = TRUE)) install.packages("remotes") remotes::install_git("https://gitbio.ens-lyon.fr/aduvermy/HTRfit") ``` -When dependencies are met, installation should take under 20 seconds. +* method B: + +Alternatively, you can download a release on https://gitbio.ens-lyon.fr/aduvermy/HTRfit/-/releases. +Then, run the following in your R console: + +``` +## -- example with release HTRfit-v1.0.0 +install.packages('/HTRfit-v1.0.0', repos = NULL, type='source') +``` + +When dependencies are met, installation should take a few minutes. ## CRAN packages dependencies +The following depandencies are mandatory: + ``` -install.packages(c("car", "parallel", "data.table", "ggplot2", "gridExtra", - "glmmTMB", "magrittr", "MASS", "plotROC", "reshape2", - "rlang", "S4Vectors", "stats", "utils")) +install.packages(c('car', 'parallel', 'data.table', 'ggplot2', 'gridExtra', 'glmmTMB', 'magrittr', 'MASS', 'plotROC', 'reshape2', 'rlang', 'stats', 'utils', 'BiocManager')) +BiocManager::install('S4Vectors', update = FALSE) ``` ### System requirements