Skip to content
CARoT: Centralised and Automated RepOrting Tools
R Perl
Branch: master
Clone or download
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
.github add coc, issue template and contributing Jun 18, 2019
R typos and style Oct 10, 2019
inst fix gender check with several local minimum Oct 17, 2019
man update doc Oct 10, 2019
tests auto-update May 6, 2019
.Rbuildignore
.gitignore auto-update May 6, 2019
.travis.yml minor changes Jul 24, 2019
CARoT.Rproj
DESCRIPTION remove dev version number Oct 17, 2019
LICENSE fix typos and fix shared repo permission May 3, 2019
NAMESPACE update doc Jul 3, 2019
NEWS.md remove dev version number Oct 17, 2019
README.Rmd remove quote from badge Sep 10, 2019
README.md remove quote from badge Sep 10, 2019
_pkgdown.yml try united Aug 9, 2019
appveyor.yml fix version number for dev Oct 8, 2019
codecov.yml fix typos and fix shared repo permission May 3, 2019

README.md

Centralised and Automated Reporting Tools

Lifecycle: experimental GitHub tag Travis-CI Build Status AppVeyor Build Status

Installation

# Install CARoT from CRAN:
install.packages("CARoT")

# Or the the development version from GitHub:
# install.packages("remotes")
remotes::install_github("mcanouil/CARoT")

Overview

CARoT (Centralised and Automated Reporting Tools) is an under development set of Quality-Control reporting tools and some other functions.

Currently CARoT includes the following functions:

  • estimate_ethnicity() allows to compute the genomic component (and some figures) for ethnicity based on VCF files.
  • ggheatmap() allows to compute heatmap with dendrogram on x-axis and y-axis using ggplot2.
  • read_idats() allows to efficiently import idats files mostly using minfi functions.
  • pca_report() allows to compute an analysis report using principal component analysis from flashpca tool.
    The function can be used in a chunk within a Rmarkdown document/script with results="asis" to render the report.
  • qc_idats() allows to compute quality-control of methylation array from Illumina using a rmarkdown template.
  • qc_plink() allows to compute quality-control of genotyping array (PLINK format) using a rmarkdown template.
  • qc_impute() allows to compute post-imputation quality-control report using a default rmarkdown template.

Getting help

If you encounter a clear bug, please file a minimal reproducible example on github.
For questions and other discussion, please contact the package maintainer.


Please note that this project is released with a Contributor Code of Conduct.
By participating in this project you agree to abide by its terms.

You can’t perform that action at this time.