Skip to content

Commit 2e4954c

Browse files
Merge pull request #73 from compbiocore/alperuzun-patch-1
Update index.md
2 parents 555bafb + 89345eb commit 2e4954c

File tree

1 file changed

+8
-5
lines changed

1 file changed

+8
-5
lines changed

docs/src/index.md

Lines changed: 8 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
![VIVA Logo](assets/VIVA_logo.png)
22

3-
Read the [VIVA Manual](https://compbiocore.github.io/VariantVisualization.jl/latest/installation/) here.
3+
44

55
# Getting Started
66

@@ -18,6 +18,9 @@ VIVA is available as a Jupyter Notebook utility [here](https://github.com/compbi
1818

1919
Formatting requirements for VIVA's input files are described in the Manual and clearly named examples of all user-generated input files can be found in the `/test/test_files` directory of the `VariantVisualization.jl` repository.
2020

21+
## Installation
22+
For detailed installation instructions, read the [VIVA Manual](https://compbiocore.github.io/VariantVisualization.jl/latest/installation/) here.
23+
2124
## General Use
2225

2326
To use VIVA, we recommend creating a new directory for storing your VCF file to analyze where output files will be saved. Alternatively, users may also provide paths to the VCF file and to preferred output file locations as command line arguments.
@@ -26,29 +29,29 @@ To use VIVA, we recommend creating a new directory for storing your VCF file to
2629
VIVA's general command line argument structure is as follows:
2730

2831
```
29-
julia viva -f file.vcf [OPTIONS]
32+
viva -f file.vcf [OPTIONS]
3033
```
3134

3235
From the command line or powershell, run the VIVA command line tool script which takes arguments from the command line and parses them with ArgParse.jl.
3336

3437
Example:
3538

3639
```
37-
julia viva -f example.vcf -r chr1:20000-30000000 -s pdf -m genotype,read_depth --avg_dp samples
40+
viva -f example.vcf -r chr1:20000-30000000 -s pdf -m genotype,read_depth --avg_dp samples
3841
```
3942

4043
To display a complete set of help instructions while using the tool, run VIVA with the help flag (`--help`, `-h`).
4144

4245
```
43-
julia viva -h
46+
viva -h
4447
```
4548

4649
### Default Options:
4750

4851
By running VIVA with only a VCF filename:
4952

5053
```
51-
julia viva -f file.vcf
54+
viva -f file.vcf
5255
```
5356

5457
Default options will be used:

0 commit comments

Comments
 (0)