Skip to content

Commit

Permalink
Update to version 1.3
Browse files Browse the repository at this point in the history
  • Loading branch information
susannasiebert committed Jan 31, 2019
1 parent 3cbffd5 commit 5b844ee
Show file tree
Hide file tree
Showing 5 changed files with 56 additions and 22 deletions.
4 changes: 2 additions & 2 deletions docs/conf.py
Original file line number Diff line number Diff line change
Expand Up @@ -67,9 +67,9 @@
# built documents.
#
# The short X.Y version.
version = '1.2'
version = '1.3'
# The full version, including alpha/beta/rc tags.
release = '1.2.0'
release = '1.3.0'

# The language for content autogenerated by Sphinx. Refer to documentation
# for a list of supported languages.
Expand Down
42 changes: 23 additions & 19 deletions docs/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -45,25 +45,29 @@ tools:
New in version |version|
------------------------

This version introduces multithreading to pVACtools. This significantly speeds
up the execution of pVACseq, pVACfuse, and pVACvector. To turn on
multithreading simply set the ``--n-threads`` parameter to the desired number
of threads. This implementation is not CPU-bound. However, when running the
tools using the IEDB RESTful API, we recommend to keep this number small (<5)
as too many parallel calls to their API might lead to IEDB blocking jobs
submitted from your IP address. It is recommended to use a standalone IEDB
installation when running with multiple threads. By default, multithreading is
turned off.

This version also fixes a few bugs:

- In certain cases pVACvector was not calculating the junction scores
correctly, leading to potentially finding a peptide order that would include
high-binding junction epitopes or peptide orders that were not optimal.
This issue has now been fixed.
- Due to a bug in our packaging code, the 1.1.x versions of pVACtools did not
include the latest version of the pVACviz code. This version now includes
the most up-to-date version of the graphical user interface.
This version adds a few features and updates:

- pVACvector now accepts a list of spacers to use when testing junction
epitopes. These can be specified using the ``--spacers`` parameter with a
comma-separated list of spacer peptides. Including the string ``None`` will
also test each junction without spacers. The default is
``None,HH,HHC,HHH,HHHD,HHHC,AAY,HHHH,HHAA,HHL,AAL``
- The ``--expn-val`` cutoff parameter has been updated to be a float instead
of an integer. This allows the user to provide a decimal
cuttoff for the filtering on gene and transcript expression values.
Previously, only whole numbers were accepted.
- Decimal numbers in the pVACseq reports are now rounded to three decimal
places. Previously, they were not rounded.

In addition, this version also fixes a few bugs:

- The ``--normal-vaf`` cutoff value was incorrectly defaulting to 0.2 instead
of 0.02. This resulted in the coverage filter not being as stringent as it
should've been.
- There were a number of bugs in pVACapi and pVACviz that would prevent a user
from submitting jobs using the interface in certain conditions. These have been resolved.
- pVACseq would previsouly not support SVs in the input VCF where the alt had
a value of ``<DEL>``. These kinds of variants are now supported.

Past release notes can be found on our :ref:`releases` page.

Expand Down
1 change: 1 addition & 0 deletions docs/releases.rst
Original file line number Diff line number Diff line change
Expand Up @@ -8,3 +8,4 @@ Release Notes

releases/1_1
releases/1_2
releases/1_3
29 changes: 29 additions & 0 deletions docs/releases/1_3.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,29 @@
Version 1.3
___________

1.3.0
-----

This version adds a few features and updates:

- pVACvector now accepts a list of spacers to use when testing junction
epitopes. These can be specified using the ``--spacers`` parameter with a
comma-separated list of spacer peptides. Including the string ``None`` will
also test each junction without spacers. The default is
``None,HH,HHC,HHH,HHHD,HHHC,AAY,HHHH,HHAA,HHL,AAL``
- The ``--expn-val`` cutoff parameter has been updated to be a float instead
of an integer. This allows the user to provide a decimal
cuttoff for the filtering on gene and transcript expression values.
Previously, only whole numbers were accepted.
- Decimal numbers in the pVACseq reports are now rounded to three decimal
places. Previously, they were not rounded.

In addition, this version also fixes a few bugs:

- The ``--normal-vaf`` cutoff value was incorrectly defaulting to 0.2 instead
of 0.02. This resulted in the coverage filter not being as stringent as it
should've been.
- There were a number of bugs in pVACapi and pVACviz that would prevent a user
from submitting jobs using the interface in certain conditions. These have been resolved.
- pVACseq would previsouly not support SVs in the input VCF where the alt had
a value of ``<DEL>``. These kinds of variants are now supported.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@

setup(
name="pvactools",
version="1.2.0",
version="1.3.0",
packages=[
"tools",
"tools.pvacfuse",
Expand Down

0 comments on commit 5b844ee

Please sign in to comment.