From 7f3c91f8ce72ae8e3ad5b1eed60c4b8b0cf4abb1 Mon Sep 17 00:00:00 2001 From: Karl Broman Date: Fri, 26 Jun 2020 06:57:55 -0500 Subject: [PATCH] README: Revise installation instructions; add CRAN badge [skip ci] --- README.md | 33 ++------------------------------- 1 file changed, 2 insertions(+), 31 deletions(-) diff --git a/README.md b/README.md index 00aebc34..ee217b13 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,7 @@ ### [R/qtl2](https://kbroman.org/qtl2) [![Build Status](https://travis-ci.org/rqtl/qtl2.svg?branch=master)](https://travis-ci.org/rqtl/qtl2) +[![CRAN_Status_Badge](https://www.r-pkg.org/badges/version/qtl2)](https://cran.r-project.org/package=qtl2) [Karl Broman](https://kbroman.org) @@ -8,15 +9,11 @@ the QTL analysis software [R/qtl](https://rqtl.org), to better handle high-dimensional data and complex cross designs. -It was previously split into the multiple packages qtl2geno, qtl2scan, -qtl2plot, and qtl2db, but that proved awkward and confusing and so the -packages have been combined. But also see the related package, +Also see the related package, [qtl2convert](https://github.com/rqtl/qtl2convert), for converting data among the R/qtl2, [DOQTL](https://www.bioconductor.org/packages/3.9/bioc/html/DOQTL.html), and [R/qtl](https://rqtl.org) formats. -[qtl2convert](https://github.com/rqtl/qtl2convert) will remain a -separate package. --- @@ -26,32 +23,6 @@ Install R/qtl2 from [CRAN](https://cran.r-project.org): install.packages("qtl2") -_Alternatively_, you can install R/qtl2 from its source on -[GitHub](https://github.com/rqtl). (But note that compiling the C++ -code can be rather slow.) - -On _Windows_, you'll need [Rtools](https://cran.r-project.org/bin/windows/Rtools/). - -On _Mac OS X_, you'll need the -[command-line developer tools](https://mac-how-to.gadgethacks.com/how-to/install-command-line-developer-tools-without-xcode-0168115/). - -You then need to install the -[devtools](https://github.com/hadley/devtools) package, plus a set of -package dependencies: [yaml](https://cran.r-project.org/package=yaml), -[jsonlite](https://cran.r-project.org/package=jsonlite), -[data.table](https://cran.r-project.org/package=data.table), -[RcppEigen](https://github.com/RcppCore/RcppEigen), -[RSQLite](https://github.com/rstats-db/RSQLite), and -[qtl](https://rqtl.org). -(Additional, secondary dependencies will also be installed.) - - install.packages(c("devtools", "yaml", "jsonlite", "data.table", "RcppEigen", "RSQLite", "qtl")) - -Finally, install R/qtl2 using `devtools::install_github()`. - - library(devtools) - install_github("rqtl/qtl2") - --- ### Vignettes