Skip to content

Commit

Permalink
Fix some documentation issues
Browse files Browse the repository at this point in the history
  • Loading branch information
susannasiebert committed Jul 27, 2023
1 parent e2f0ea5 commit f02d7e2
Show file tree
Hide file tree
Showing 4 changed files with 9 additions and 9 deletions.
8 changes: 4 additions & 4 deletions docs/pvacbind/output_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -26,11 +26,11 @@ created):
* - ``<sample_name>.filtered.tsv``
- The above file after applying all filters, with cleavage site and stability
predictions added.
* - ``<sample_name>.filtered.tsv.reference_matches`` (optional)
- A file outlining details of reference proteome matches
* - ``<sample_name>.all_epitopes.aggregated.tsv``
- An aggregated version of the ``all_epitopes.tsv`` file that gives information about
the best epitope for each mutation in an easy-to-read format.
* - ``<sample_name>.all_epitopes.aggregated.tsv.reference_matches`` (optional)
- A file outlining details of reference proteome matches

Filters applied to the filtered.tsv file
----------------------------------------
Expand Down Expand Up @@ -243,8 +243,8 @@ Criteria Details

.. _pvacbind_reference_matches:

filtered.tsv.reference_matches Report Columns
---------------------------------------------
aggregated.tsv.reference_matches Report Columns
-----------------------------------------------

This file is only generated when the ``--run-reference-proteome-similarity``
option is chosen.
Expand Down
4 changes: 2 additions & 2 deletions docs/pvacfuse/output_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -37,11 +37,11 @@ created):
* - ``<sample_name>.filtered.tsv``
- The above file after applying all filters, with cleavage site and stability
predictions added.
* - ``<sample_name>.filtered.tsv.reference_matches`` (optional)
- A file outlining details of reference proteome matches
* - ``<sample_name>.all_epitopes.aggregated.tsv``
- An aggregated version of the ``all_epitopes.tsv`` file that gives information about
the best epitope for each mutation in an easy-to-read format.
* - ``<sample_name>.all_epitopes.aggregated.tsv.reference_matches`` (optional)
- A file outlining details of reference proteome matches

Filters applied to the filtered.tsv file
----------------------------------------
Expand Down
2 changes: 1 addition & 1 deletion docs/pvacseq/getting_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -12,7 +12,7 @@ The example data output can be reproduced by running the following command:
.. code-block:: none
pvacseq run \
<example_data_dir>/input.vcf \
<example_data_dir>/annotated.expression.vcf.gz \
HCC1395_TUMOR_DNA \
HLA-A*29:02,HLA-B*45:01,DRB1*04:05 \
all \
Expand Down
4 changes: 2 additions & 2 deletions docs/pvacseq/output_files.rst
Original file line number Diff line number Diff line change
Expand Up @@ -41,11 +41,11 @@ created):
* - ``<sample_name>.filtered.tsv``
- The above file after applying all filters, with (optionally) cleavage site, stability
predictions, and reference proteome similarity metrics added.
* - ``<sample_name>.filtered.tsv.reference_matches`` (optional)
- A file outlining details of reference proteome matches
* - ``<sample_name>.all_epitopes.aggregated.tsv``
- An aggregated version of the ``all_epitopes.tsv`` file that gives information about
the best epitope for each mutation in an easy-to-read format.
* - ``<sample_name>.all_epitopes.aggregated.tsv.reference_matches`` (optional)
- A file outlining details of reference proteome matches
* - ``<sample_name>.all_epitopes.aggregated.metrics.json``
- A JSON file with detailed information about the predicted epitopes,
formatted for pVACview. This file, in combination with the
Expand Down

0 comments on commit f02d7e2

Please sign in to comment.