Skip to content

Commit

Permalink
docs(Readme): added link to examples to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
gtollefson committed Apr 4, 2019
1 parent 447db1c commit d0d0607
Show file tree
Hide file tree
Showing 2 changed files with 7 additions and 2 deletions.
8 changes: 6 additions & 2 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -15,7 +15,11 @@ VariantVisualization.jl is a package we built specifically to power the genetics

To use VIVA, you must download the Julia programming language version >=1.0 and install the VariantVisualization.jl Julia package as well as the VIVA script.

## Getting Started: *Installation*
## Getting Started:

Note: Once you have set up VIVA, you can quickly run the command line tool [examples](https://compbiocore.github.io/VariantVisualization.jl/stable/examples/) found in the documentation.

*Installation*

### Supported Operating Systems:

Expand All @@ -34,7 +38,7 @@ Windows 10, Windows 7
b. run `Pkg.clone("https://github.com/compbiocore/VariantVisualization.jl")`
c. run `Pkg.instantiate()`
2. Download the [VIVA](https://github.com/compbiocore/VariantVisualization.jl/blob/master/viva) tool script and save it to a working directory for your analysis.
3. Navigate to your working directory and follow the [VIVA manual](https://compbiocore.github.io/VariantVisualization.jl/latest/) to generate your plots.
3. Navigate to your working directory and follow the [VIVA manual](https://compbiocore.github.io/VariantVisualization.jl/stable/) to generate your plots.

### Jupyter Notebook

Expand Down
1 change: 1 addition & 0 deletions docs/src/examples.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,6 +13,7 @@ julia VIVA -f test_4X_191.vcf -t Default_Options
```

![Default Genotype Heatmap](assets/Genotype_Default_Options.html)

![Default Read Depth Heatmap](assets/Read_Depth_Default_Options.html)

## Grouping Samples by Metadata Traits and Generating all Four Plots
Expand Down

0 comments on commit d0d0607

Please sign in to comment.