Skip to content

green-striped-gecko/dartR

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

Main repository: CRAN checks R-CMD-check R-CMD-check-beta

Publication:

Zenodo: DOI

Dev repositories: R-CMD-check-dev R-CMD-check-dev_Arthur R-CMD-check-dev_Bernd R-CMD-check-dev_Luis R-CMD-check-dev_Carlo

Importing and Analysing Snp and Silicodart Data Generated by Genome-Wide-Restriction Fragment Analysis


Changelog (list of newly integrated functions)

Changelog


Installation via CRAN

The package is now on CRAN, so to install simply type:

install.packages("dartR")
library(dartR)

The latest version 1.9.9.1 introduces a two tier system as CRAN is limiting the numbers of packages that can be installed with a package. So the install.packages command above, installs only the base packages that are needed for the import, filter and report functions to work. For many other advanced functions additional packages are needed. To automate this process you need to invoke the gl.install.vanilla.dartR function.

gl.install.vanilla.dartR(flavour="CRAN")

You can install different flavours (repositories) as well, so for the "dev" version from github you can use:

gl.install.vanilla.dartR(flavour="dev")

"master" installs the master version from Github, which is 99.9% percent of the time identical with CRAN. There is a slight delay for new versions to appear on CRAN so the master version can be slightly newer than the CRAN version. Be aware the "dev" versions are not fully tested yet and function may not work as intended. You can see if a current version runs all checks successfully by checking the banners at the top of this page.

The package also includes a nice introdcutory tutorial (called vignette in R terminology). Once installed type:

browseVignettes("dartR")

to access it.


Manual installation of the latest version (R>3.5)

To install the latest package manually follow the description below:

The installation of the package might not run smoothly, as it requires additional bioconductor packages that need to be installed. To install the packages and all dependencies copy paste the script below into your R-console. (If you are lucky it simply installs all packages without any error message and you are done):

install.packages("devtools")
library(devtools)
install.packages("BiocManager")
BiocManager::install(c("SNPRelate", "qvalue"))
install_github("green-striped-gecko/dartR")
library(dartR)

You may need to install additional packages either manually or using the gl.install.vanilla() function.

Manual installation of the latest version (R<3.5)

The BiocManager package is not available for R<3.5, hence you may need to use the following code:

source("https://bioconductor.org/biocLite.R")
BiocInstaller::biocLite(c("SNPRelate", "qvalue"))
install.packages("dartR")
library(dartR)

Unfortunately sometimes to us unkown reasons R is not able to install all dependent packages and breaks with an error message. Then you need to install packages "by hand". For example you may find:

ERROR: dependency 'seqinr' is not available for package 'dartR'
removing 'C:/Program Files/R/library/dartR'
Error: Command failed (1)

Then you need to install the package seqinr via:

install.packages("seqinr")

And run the last line of code again:

install_github("green-striped-gecko/dartR")

This "game" of install.packages() and install_github() [the last two steps] might need to be repeated for additional packages as for whatever reason R does no longer install all packages (if anyone could tell me a way to fix this, it would be highly appreciated). Finally you should be able to run:

install_github("green-striped-gecko/dartR")
library(dartR)

without any error (warnings if you are using an older version of R are okay) and you are done.

In case you want to have the latest version of the package you can download the developer version via:

install_github("green-striped-gecko/dartR@dev")

!!Please note the here it is quite likely that some functions might not work, or even the install might break with an error.!!

Documentation, tutorials and sample files are available at: http://georges.biomatix.org/dartR

Q&A forum in support of users can be accessed at: https://groups.google.com/g/dartr?pli=1

If you use dartR in your research, please support us by citing dartR. You can find the citation information by typing in the R console:

citation("dartR”)

Have fun working with dartR! Any issues you encounter please use the issues tab on github or contact us via email under glbugs@aerg.canberra.edu.au

Cheers,

Bernd, Arthur, Luis & Carlo

About

Importing and Analysing DArT type snp and silicodart data

Resources

Code of conduct

Stars

Watchers

Forks

Packages

No packages published

Languages