Skip to content
Snippets Groups Projects
Commit 76d0b9ab authored by arq5x's avatar arq5x
Browse files

sync docs

parent 5b55adb5
No related branches found
No related tags found
No related merge requests found
File deleted
############### ###############
Tips and Tricks Tips and Tricks
############### ###############
\ No newline at end of file
======================
The ``-sorted`` option
======================
\ No newline at end of file
...@@ -38,9 +38,11 @@ Option Description ...@@ -38,9 +38,11 @@ Option Description
always report mate one as the first BEDPE "block". always report mate one as the first BEDPE "block".
**-bed12** Write "blocked" BED (a.k.a. BED12) format. This will convert **-bed12** Write "blocked" BED (a.k.a. BED12) format. This will convert
"spliced" BAM alignments (denoted by the "N" CIGAR operation) "spliced" BAM alignments (denoted by the "N" CIGAR operation)
to BED12. to BED12. `Forces -split`.
**-split** Report each portion of a "split" BAM (i.e., having an "N" CIGAR **-split** Report each portion of a "split" BAM (i.e., having an "N" CIGAR
operation) alignment as a distinct BED intervals. operation) alignment as a distinct BED intervals.
**-splitD** Report each portion of a "split" BAM while obeying noth "N" CIGAR
and "D" operation. Forces `-split`.
**-ed** Use the "edit distance" tag (NM) for the BED score field. **-ed** Use the "edit distance" tag (NM) for the BED score field.
Default for BED is to use mapping quality. Default for BEDPE is Default for BED is to use mapping quality. Default for BEDPE is
to use the *minimum* of the two mapping qualities for the pair. to use the *minimum* of the two mapping qualities for the pair.
......
...@@ -119,7 +119,7 @@ For example: ...@@ -119,7 +119,7 @@ For example:
# are 20bp whereas the flanking intervals from the first record # are 20bp whereas the flanking intervals from the first record
# are only 10bp # are only 10bp
################################################################ ################################################################
$ bedtools flank -i A.bed -g my.genome -b 0.5 -pct $ bedtools flank -i A.bed -g my.genome -b 0.1 -pct
chr1 90 100 chr1 90 100
chr1 200 210 chr1 200 210
chr1 480 500 chr1 480 500
......
...@@ -21,7 +21,7 @@ with both BED/GFF/VCF and BAM files as input. ...@@ -21,7 +21,7 @@ with both BED/GFF/VCF and BAM files as input.
If you are trying to intersect very large files and are having trouble If you are trying to intersect very large files and are having trouble
with excessive memory usage, please presort your data by chromosome and with excessive memory usage, please presort your data by chromosome and
then by start position (e.g., ``sort k1,1 -k2,2n in.bed > in.sorted.bed`` then by start position (e.g., ``sort -k1,1 -k2,2n in.bed > in.sorted.bed``
for BED files) and then use the ``-sorted`` option. This invokes a for BED files) and then use the ``-sorted`` option. This invokes a
memory-efficient algorithm designed for large files. memory-efficient algorithm designed for large files.
......
...@@ -48,6 +48,7 @@ Usage and option summary ...@@ -48,6 +48,7 @@ Usage and option summary
**-bedpe** Indicate that the A file is in BEDPE format. **-bedpe** Indicate that the A file is in BEDPE format.
**-maxTries** Max. number of attempts to find a home for a shuffled interval in the presence of -incl or -excl. *Default = 1000.* **-maxTries** Max. number of attempts to find a home for a shuffled interval in the presence of -incl or -excl. *Default = 1000.*
**-noOverlapping** Don't allow shuffled intervals to overlap. **-noOverlapping** Don't allow shuffled intervals to overlap.
**-allowBeyondChromEnd** Allow the original the length of the original records to extebd beyond the length of the chromosome.
=========================== =============================================================================================================================================================================================================== =========================== ===============================================================================================================================================================================================================
...@@ -207,4 +208,23 @@ no such overlaps. ...@@ -207,4 +208,23 @@ no such overlaps.
$ bedtools shuffle -i A.bed -g my.genome -noOverlapping $ bedtools shuffle -i A.bed -g my.genome -noOverlapping
==========================================================================
``-allowBeyondChromEnd`` Allow records to extend beyond the chrom. length.
==========================================================================
By default, ``shuffle`` requires that an interval's original length must be
fully-contained within the chromosome. Yet there are cases where you might
want to allow shuffled intervals to be relocated to a position
in which the entire original interval cannot fit w/o exceeding
the end of the chromosome. By using the ``-noOverlapping`` option,
``shuffle`` will allow intervals to be shuffled to locations that are so close
to the chromosome end that the full length of the original record cannot
be contained within the chromosome length. In such cases, the end coordinate
for the shuffled interval will be set (i.e., truncated)
to the chromosome's length.
.. code-block:: bash
$ bedtools shuffle -i A.bed -g my.genome -allowBeyondChromEnd
...@@ -103,7 +103,7 @@ and ``-r`` (downstream)** options. ...@@ -103,7 +103,7 @@ and ``-r`` (downstream)** options.
.. note:: .. note::
By default, the ``-l`` and ``-r`` options ignore. If you want to define By default, the ``-l`` and ``-r`` options ignore strand. If you want to define
*upstream* and *downstream* based on strand, use the ``-sw`` option (below) *upstream* and *downstream* based on strand, use the ``-sw`` option (below)
with the ``-l`` and ``-r`` options. with the ``-l`` and ``-r`` options.
......
...@@ -525,6 +525,9 @@ div.warning p.admonition-title { ...@@ -525,6 +525,9 @@ div.warning p.admonition-title {
} }
/* Sidebars only */ /* Sidebars only */
div.sidebar { div.sidebar {
max-width: 200px; max-width: 200px;
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment