Skip to content
This repository has been archived by the owner. It is now read-only.

Commit

Permalink
updated internals flag manual
Browse files Browse the repository at this point in the history
  • Loading branch information
afust committed Jun 20, 2017
1 parent 4b44016 commit 5b3a6d9
Showing 1 changed file with 11 additions and 5 deletions.
16 changes: 11 additions & 5 deletions docs_rst/config.rst
Original file line number Diff line number Diff line change
Expand Up @@ -80,15 +80,21 @@ Each query can specify the following keys:
Example: ``'direction': ['upstream','downstream']``


- **internals**: This key represents a modifier with respect to the ``'distance``' key. This can be helpful to annotate peaks to features with a wide size range, such as genes, which would otherwise be removed due to the distance thresholds. So even if the desired feature anchor is located too far away, a feature can still be included if it is overlapped.
- **internals**: This key represents a modifier with respect to the ``'distance'`` key. This can be helpful to annotate peaks to features with a wide size range, such as genes, which would otherwise be removed due to the distance thresholds. So even if the desired feature anchor is located too far away, a feature can still be included if it is overlapped.

'center': If the center of a peak intersects with a feature region or vice versa, the ``'distance``' key filtering is disabled. This parameter ensures that the majority of the peak intersects with the feature.
'center': If the center of a peak intersects with a feature region or vice versa, the ``'distance'`` key filtering is disabled. This parameter ensures that the majority of the peak intersects with the feature.

'any': If a peak intersects with a feature region or vice versa, the ``'distance``' key filtering is disabled. An overlap of >= 1 nt is sufficient.
'any': If a peak intersects with a feature region or vice versa, the ``'distance'`` key filtering is disabled. An overlap of >= 1 nt is sufficient.

Allowed values are one of ``'F', 'False', 'N', 'No'``, 'center', or 'any'.
'none': Internals key is turned off. The ``'distance'`` key is active.

Default: ``'any'``
Allowed values are one of ``'none', 'center', or 'any'.``

Furthermore, ``'T', 'True', 'Y', 'Yes'`` are allowed and will be treated as ``'center'``,

``'F', 'False', 'N', 'No'`` are allowed and will be treated as ``'none'``.

Default: ``'none'``

Example: ``'internals':'center'``

Expand Down

0 comments on commit 5b3a6d9

Please sign in to comment.