Skip to content

S4 classes for QTL summary statistics and metadata

License

Notifications You must be signed in to change notification settings

dunstone-a/QTLExperiment

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

79 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

QTLExperiment Package

QTLExperiment is an R container package for storing and manipulating QTL summary statistics.

Project Status Project Status.
Latest release 2022-11-08

Installation and Usage

This package can be installed from Bioconductor using the following code:

if (!require("BiocManager", quietly=TRUE))
    install.packages("BiocManager")

BiocManager::install("QTLExperiment", version = "devel")

Using the most recent version of R is strongly recommended (R 4.3.1 at the time of writing).

There are several other packages from CRAN and Bioconductor that QTLExperiment uses, so you will need to have these packages installed as well. The CRAN packages should install automatically when QTLExperiment is installed, but you will need to install the Bioconductor packages manually.

Not all of the following are strictly necessary, but have been included here as they enhance the functionality of QTLExperiment. The commands below should help with package installations.

CRAN

install.packages(c("knitr", "dplyr", "collapse", "vroom", "ashr", "tidyr", "testthat"))

Bioconductor

BiocManager::install(c("SummarizedExperiment", "BiocGenerics", "S4Vectors"))

Getting started

Get started with QTLExperiment by checking out the vignette that introduces the main features and functionality of QTLExperiment. From inside an R session, load QTLExperiment and then browse the vignettes:

library(QTLExperiment)
browseVignettes("QTLExperiment")

Acknowledgements and disclaimer

The package leans heavily on previously published work and packages, namely SummarizedExperiment. The QTLE S4 class is inspired by SingleCellExperiment.

The package is currently in a Beta state. The major functionality of the package is settled, but it is still under development so may change from time to time. Please do try it and contact me with bug reports, feedback, feature requests, questions and suggestions to improve the package.

Christina Brady Del Azodi, November 2022

About

S4 classes for QTL summary statistics and metadata

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published

Languages