Git Product home page Git Product logo

visualvariants's Introduction

VisualVariants

The goal of this project is to create an R package and executable scripts to visualize variants in variant call format (VCF) files and bcftools tab-delimited files.

Requirements

In order to run the VisualVariants, users need to install software, programming languages, and packages in their computing systems. The software, programming languages, and packages include:

R>=3.6.0

Installation

You can install the VisualVariants from Github with:

# Run this inside R environment
install.packages("devtools", dependencies = TRUE)
devtools::install_github("yenon118/VisualVariants")
# Run this in your terminal
git clone https://github.com/yenon118/VisualVariants.git

Usage

  1. generateMissingVariantCountStackBarChartParallel.R
Rscript scripts/generateMissingVariantCountStackBarChartParallel.R [-h] [--cores CORES] --inputs INPUTS --output OUTPUT [--all]

mandatory arguments:
  --inputs INPUTS       Input bcftools tab delimited files
  --output OUTPUT       Output file path

optional arguments:
  -h, --help            show this help message and exit
  --cores CORES         Number of processing cores
  --all                 Output all files
  1. generateSampleMissingPercentageScatterPlotParallel.R
Rscript scripts/generateSampleMissingPercentageScatterPlotParallel.R [-h] [--cores CORES] --inputs INPUTS --output OUTPUT [--all]

mandatory arguments:
  --inputs INPUTS       Input bcftools tab delimited files
  --output OUTPUT       Output file path

optional arguments:
  -h, --help            show this help message and exit
  --cores CORES         Number of processing cores
  --all                 Output all files
  1. generateVariantCountHistogramParallel.R
Rscript scripts/generateVariantCountHistogramParallel.R [-h] [--cores CORES] --inputs INPUTS --output OUTPUT [--gap GAP] [--binwidth BINWIDTH]

mandatory arguments:
  --inputs INPUTS       Input bcftools tab delimited files
  --output OUTPUT       Output file path

optional arguments:
  -h, --help            show this help message and exit
  --cores CORES         Number of processing cores
  --gap GAP             Gap of ticks in the x axis
  --binwidth BINWIDTH   Width of each bin for the histogram

Examples

These are basic examples which show you how to use VisualVariants:

  1. generateMissingVariantCountStackBarChartParallel.R
Rscript scripts/generateMissingVariantCountStackBarChartParallel.R \
--cores 3 \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr01.txt \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr02.txt \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr03.txt \
--output /scratch/yenc/projects/VisualVariants/output/missing_variant_count_stack_bar_chart.png \
--all
  1. generateSampleMissingPercentageScatterPlotParallel.R
Rscript scripts/generateSampleMissingPercentageScatterPlotParallel.R \
--cores 3 \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr01.txt \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr02.txt \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr03.txt \
--output /scratch/yenc/projects/VisualVariants/output/sample_missing_percentage_scatter_plot.png \
--all
  1. generateVariantCountHistogramParallel.R
Rscript scripts/generateVariantCountHistogramParallel.R \
--cores 3 \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr01.txt \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr02.txt \
--inputs /scratch/yenc/projects/VisualVariants/data/Nebraska.Chr03.txt \
--output /scratch/yenc/projects/VisualVariants/output/variant_count_histogram.png

Results

These are basic examples which show you how to use VisualVariants:

  1. generateMissingVariantCountStackBarChartParallel.R

missing variant count stack bar chart

  1. generateSampleMissingPercentageScatterPlotParallel.R

sample missing percentage scatter plot

  1. generateVariantCountHistogramParallel.R

variant_count_histogram

Package Update

To upgrade VisualVariants to the latest version, please remove the package and re-install the latest VisualVariants package:

# Run this inside R environment
remove.packages("VisualVariants")
devtools::install_github("yenon118/VisualVariants")

visualvariants's People

Contributors

yenon118 avatar

Stargazers

 avatar  avatar

Watchers

 avatar  avatar

visualvariants's Issues

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.