Skip to content

Commit

Permalink
doc/vidjil-algo.md: precision on --filter
Browse files Browse the repository at this point in the history
Closes #3684.
  • Loading branch information
magiraud committed Mar 14, 2019
1 parent 85d9a12 commit 4f97fe7
Showing 1 changed file with 3 additions and 1 deletion.
4 changes: 3 additions & 1 deletion doc/vidjil-algo.md
Original file line number Diff line number Diff line change
Expand Up @@ -449,7 +449,9 @@ More generally, when the provided sequence differs in length with the windows
we will keep any windows that contain the sequence of interest or, conversely,
we will keep any window that is contained in the sequence of interest.
This filtering will work as expected when the provided sequence overlaps
(at least partially) the CDR3 or its close neighborhood.
(at least partially) the CDR3 or its close neighborhood,
but will not work when the sequence is far of the CDR3 (except when
using large `-w` values or `-w all`).

With the `--label-filter` option, *only* the windows related to the given sequences are kept.
This allows to quickly filter a set of reads, looking for a known sequence or window,
Expand Down

0 comments on commit 4f97fe7

Please sign in to comment.