Skip to content

Commit

Permalink
Fixed table
Browse files Browse the repository at this point in the history
  • Loading branch information
aewebb80 committed Jul 30, 2020
1 parent edbaa82 commit 0072865
Showing 1 changed file with 2 additions and 1 deletion.
3 changes: 2 additions & 1 deletion docs/source/PPP_pages/examples.rst
Original file line number Diff line number Diff line change
Expand Up @@ -27,6 +27,7 @@ PPP functions may also be imported from the **pgpipe** module for use within a p
vcf_filter.run(vcf = 'examples/files/merged_chr1_10000.vcf.gz', filter_only_biallelic = True, out_format = 'bcf')
In comparison to calling functions at the command-line, imported functions require:

* The pgpipe module must be imported
* Each function is called using .run(): **vcf_filter.run() or pgpipe.vcf_filter.run()**
* The use of underscores within arguments rather than dashes: **--out-format vs. out_format**
Expand All @@ -47,4 +48,4 @@ We have included two example notebooks within the **examples/jupyter** directory

Jupyter Notebooks may also be download using the following links:

* :download:`Example Jupyter Pipleine <jupyter/example_pipeline_pan.ipynb>`.
* :download:`Example Jupyter Pipleine <jupyter/example_pipeline_pan.ipynb>`.

0 comments on commit 0072865

Please sign in to comment.