Skip to content

Commit

Permalink
Merge pull request #67 from griffithlab/docs
Browse files Browse the repository at this point in the history
Update vcf-expression-annotator documentation to clarify custom id-column parameter
  • Loading branch information
susannasiebert authored Oct 16, 2023
2 parents 47e6688 + 9b02fb0 commit ad6167c
Showing 1 changed file with 4 additions and 3 deletions.
7 changes: 4 additions & 3 deletions docs/vcf_expression_annotator.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,17 @@ file.

The VCF Expression Annotator also accepts a custom tab-delimited (TSV) file input for the
expression file. This TSV file will need to contain one column with gene or
transcripts identifiers and one column with the expression values. This file
transcrip Ensembl IDs and one column with the expression values. This file
then needs to contain a header line that is used to
identify the contents of each column. This is done via the ``--id-column``
and ``--expression-column`` parameters which need
to match the gene/transcript identifier and expression value column headers.
In order to use this option the expression file format option will need to be
set to ``custom``.
set to ``custom``. Please note that when running in ``gene`` mode, the ID
column will need to contain Ensembl Gene IDs, not gene names.

By default the output VCF will be written to a ``.tx.vcf`` or ``.gx.vcf`` file next to
your input VCF file. You can set a different output file using the
your input VCF file. You can set a different output file name using the
``--output-vcf`` parameter.

Usage
Expand Down

0 comments on commit ad6167c

Please sign in to comment.