From 0bfdf859fb26a0cc7f185007c882ff7cf0125c2d Mon Sep 17 00:00:00 2001 From: GitHub Action Date: Tue, 9 Apr 2024 23:19:32 +0000 Subject: [PATCH] update docs --- 3-brief-examples.html | 31 +- FAQs.html | 39 +- _modules/index.html | 23 +- _modules/pybedtools.html | 34 +- _modules/pybedtools/bedtool.html | 508 +++++++++++++----- _modules/pybedtools/contrib/bigbed.html | 41 +- _modules/pybedtools/contrib/bigwig.html | 38 +- .../contrib/intersection_matrix.html | 33 +- .../contrib/long_range_interaction.html | 47 +- _modules/pybedtools/contrib/plotting.html | 84 ++- _modules/pybedtools/contrib/venn_maker.html | 34 +- _modules/pybedtools/filenames.html | 36 +- _modules/pybedtools/helpers.html | 76 ++- _modules/pybedtools/parallel.html | 28 +- .../pybedtools.contrib.plotting.Track.rst.txt | 3 + _sources/changes.rst.txt | 11 + _sources/topical-bam.rst.txt | 3 +- _static/alabaster.css | 23 +- _static/basic.css | 6 +- _static/documentation_options.js | 5 +- _static/pygments.css | 2 +- _static/searchtools.js | 26 +- _static/sphinx_highlight.js | 16 +- autodoc_source.html | 69 +-- ...ols.bedtool.BedTool.absolute_distance.html | 27 +- .../pybedtools.bedtool.BedTool.all_hits.html | 27 +- .../pybedtools.bedtool.BedTool.annotate.html | 29 +- .../pybedtools.bedtool.BedTool.any_hits.html | 27 +- ...tools.bedtool.BedTool.as_intervalfile.html | 27 +- autodocs/pybedtools.bedtool.BedTool.at.html | 27 +- ...pybedtools.bedtool.BedTool.bam_to_bed.html | 29 +- ...bedtools.bedtool.BedTool.bam_to_fastq.html | 29 +- autodocs/pybedtools.bedtool.BedTool.bed6.html | 29 +- ...bedtools.bedtool.BedTool.bedpe_to_bam.html | 29 +- .../pybedtools.bedtool.BedTool.bgzip.html | 27 +- autodocs/pybedtools.bedtool.BedTool.cat.html | 27 +- .../pybedtools.bedtool.BedTool.closest.html | 29 +- .../pybedtools.bedtool.BedTool.cluster.html | 29 +- ...ls.bedtool.BedTool.colormap_normalize.html | 27 +- ...pybedtools.bedtool.BedTool.complement.html | 29 +- .../pybedtools.bedtool.BedTool.count.html | 27 +- ...pybedtools.bedtool.BedTool.count_hits.html | 27 +- .../pybedtools.bedtool.BedTool.coverage.html | 29 +- autodocs/pybedtools.bedtool.BedTool.cut.html | 27 +- autodocs/pybedtools.bedtool.BedTool.each.html | 27 +- .../pybedtools.bedtool.BedTool.expand.html | 87 +-- ...ybedtools.bedtool.BedTool.field_count.html | 27 +- .../pybedtools.bedtool.BedTool.file_type.html | 27 +- .../pybedtools.bedtool.BedTool.filter.html | 27 +- .../pybedtools.bedtool.BedTool.flank.html | 29 +- ...tools.bedtool.BedTool.genome_coverage.html | 29 +- .../pybedtools.bedtool.BedTool.groupby.html | 201 +++---- autodocs/pybedtools.bedtool.BedTool.head.html | 27 +- autodocs/pybedtools.bedtool.BedTool.html | 29 +- autodocs/pybedtools.bedtool.BedTool.igv.html | 29 +- .../pybedtools.bedtool.BedTool.intersect.html | 29 +- .../pybedtools.bedtool.BedTool.introns.html | 27 +- .../pybedtools.bedtool.BedTool.jaccard.html | 29 +- .../pybedtools.bedtool.BedTool.liftover.html | 27 +- .../pybedtools.bedtool.BedTool.links.html | 29 +- autodocs/pybedtools.bedtool.BedTool.map.html | 29 +- ...pybedtools.bedtool.BedTool.mask_fasta.html | 29 +- .../pybedtools.bedtool.BedTool.merge.html | 29 +- .../pybedtools.bedtool.BedTool.moveto.html | 27 +- ...ls.bedtool.BedTool.multi_bam_coverage.html | 29 +- ...tools.bedtool.BedTool.multi_intersect.html | 29 +- ...ls.bedtool.BedTool.nucleotide_content.html | 29 +- .../pybedtools.bedtool.BedTool.overlap.html | 63 +-- ...ybedtools.bedtool.BedTool.pair_to_bed.html | 29 +- ...bedtools.bedtool.BedTool.pair_to_pair.html | 29 +- ...dtools.bedtool.BedTool.parallel_apply.html | 27 +- ...dtools.bedtool.BedTool.print_sequence.html | 27 +- .../pybedtools.bedtool.BedTool.random.html | 29 +- ...dtools.bedtool.BedTool.random_jaccard.html | 27 +- .../pybedtools.bedtool.BedTool.random_op.html | 27 +- ...edtools.bedtool.BedTool.random_subset.html | 27 +- ...ls.bedtool.BedTool.randomintersection.html | 27 +- ...bedtool.BedTool.randomintersection_bp.html | 27 +- ...ybedtools.bedtool.BedTool.randomstats.html | 27 +- ...ols.bedtool.BedTool.relative_distance.html | 27 +- .../pybedtools.bedtool.BedTool.reldist.html | 29 +- ...dtools.bedtool.BedTool.remove_invalid.html | 27 +- .../pybedtools.bedtool.BedTool.save_seqs.html | 27 +- .../pybedtools.bedtool.BedTool.saveas.html | 27 +- autodocs/pybedtools.bedtool.BedTool.seq.html | 27 +- .../pybedtools.bedtool.BedTool.sequence.html | 29 +- ...dtools.bedtool.BedTool.set_chromsizes.html | 27 +- .../pybedtools.bedtool.BedTool.shuffle.html | 29 +- autodocs/pybedtools.bedtool.BedTool.slop.html | 29 +- autodocs/pybedtools.bedtool.BedTool.sort.html | 29 +- .../pybedtools.bedtool.BedTool.split.html | 27 +- .../pybedtools.bedtool.BedTool.subtract.html | 29 +- .../pybedtools.bedtool.BedTool.tabix.html | 27 +- ...tools.bedtool.BedTool.tabix_intervals.html | 27 +- .../pybedtools.bedtool.BedTool.tag_bam.html | 29 +- .../pybedtools.bedtool.BedTool.to_bam.html | 27 +- ...dtools.bedtool.BedTool.total_coverage.html | 27 +- ...ols.bedtool.BedTool.truncate_to_chrom.html | 27 +- ...tools.bedtool.BedTool.union_bedgraphs.html | 29 +- .../pybedtools.bedtool.BedTool.window.html | 29 +- ...bedtools.bedtool.BedTool.window_maker.html | 353 ++++++------ ...pybedtools.bedtool.BedTool.with_attrs.html | 27 +- .../pybedtools.bedtool.example_bedtool.html | 27 +- autodocs/pybedtools.cbedtools.Interval.html | 29 +- ...s.cbedtools.create_interval_from_list.html | 27 +- ...pybedtools.contrib.IntersectionMatrix.html | 29 +- .../pybedtools.contrib.bigbed.bigbed.html | 27 +- ...bedtools.contrib.bigbed.bigbed_to_bed.html | 27 +- ...bedtools.contrib.bigwig.bam_to_bigwig.html | 27 +- ...ols.contrib.bigwig.bedgraph_to_bigwig.html | 27 +- ...bedtools.contrib.bigwig.wig_to_bigwig.html | 27 +- ...ge_interaction.cis_trans_interactions.html | 27 +- ...trib.long_range_interaction.tag_bedpe.html | 27 +- ...edtools.contrib.plotting.BedToolsDemo.html | 29 +- ...ntrib.plotting.ConfiguredBedToolsDemo.html | 29 +- .../pybedtools.contrib.plotting.Track.html | 288 +++++----- ...ools.contrib.plotting.TrackCollection.html | 29 +- ...tools.contrib.plotting.binary_heatmap.html | 27 +- ...tools.contrib.plotting.binary_summary.html | 27 +- ....contrib.venn_maker.cleaned_intersect.html | 27 +- autodocs/pybedtools.contrib.venn_maker.html | 25 +- ...edtools.contrib.venn_maker.venn_maker.html | 27 +- autodocs/pybedtools.debug_mode.html | 27 +- ...pybedtools.filenames.example_filename.html | 27 +- ...bedtools.filenames.list_example_files.html | 27 +- autodocs/pybedtools.helpers.chromsizes.html | 29 +- ...pybedtools.helpers.chromsizes_to_file.html | 27 +- autodocs/pybedtools.helpers.cleanup.html | 27 +- ...ools.helpers.get_chromsizes_from_ucsc.html | 27 +- autodocs/pybedtools.helpers.get_tempdir.html | 27 +- .../pybedtools.helpers.set_bedtools_path.html | 27 +- autodocs/pybedtools.helpers.set_tempdir.html | 27 +- .../pybedtools.parallel.parallel_apply.html | 27 +- changes.html | 106 ++-- create-a-bedtool-tutorial.html | 25 +- default-arguments.html | 27 +- each.html | 25 +- filtering.html | 27 +- flow-of-commands.html | 35 +- genindex.html | 23 +- history.html | 27 +- includeme.html | 23 +- index.html | 36 +- intersections.html | 25 +- intervals.html | 37 +- intro.html | 27 +- main.html | 51 +- objects.inv | Bin 4218 -> 4219 bytes piping.html | 27 +- py-modindex.html | 23 +- pybedtools-dev-history.html | 25 +- pybedtools.featurefuncs.TSS.html | 27 +- pybedtools.featurefuncs.add_color.html | 27 +- pybedtools.featurefuncs.bed2gff.html | 27 +- pybedtools.featurefuncs.bedgraph_scale.html | 27 +- pybedtools.featurefuncs.center.html | 27 +- pybedtools.featurefuncs.extend_fields.html | 27 +- pybedtools.featurefuncs.five_prime.html | 27 +- pybedtools.featurefuncs.gff2bed.html | 27 +- pybedtools.featurefuncs.greater_than.html | 27 +- pybedtools.featurefuncs.less_than.html | 27 +- pybedtools.featurefuncs.midpoint.html | 27 +- ...ols.featurefuncs.normalized_to_length.html | 27 +- pybedtools.featurefuncs.rename.html | 27 +- pybedtools.featurefuncs.three_prime.html | 27 +- save-results.html | 25 +- scripts.html | 25 +- search.html | 23 +- searchindex.js | 2 +- sh-comparison.html | 29 +- topical-bam-semantics.html | 25 +- topical-bam.html | 28 +- topical-comparisons.html | 25 +- topical-create-a-bedtool.html | 25 +- topical-design-principles.html | 39 +- topical-documentation-contents.html | 25 +- topical-genome.html | 33 +- topical-iterators.html | 29 +- topical-low-level-ops.html | 25 +- topical-random.html | 29 +- topical-saving.html | 33 +- topical-wrapping.html | 39 +- tutorial-contents.html | 25 +- 183 files changed, 3532 insertions(+), 2993 deletions(-) diff --git a/3-brief-examples.html b/3-brief-examples.html index 91cf10e8..43dbf3a4 100644 --- a/3-brief-examples.html +++ b/3-brief-examples.html @@ -1,16 +1,16 @@ - + - Three brief examples — pybedtools 0.9.1 documentation - - - + Three brief examples — pybedtools 0.10.0 documentation + + + - + @@ -18,8 +18,9 @@ + + - @@ -32,7 +33,7 @@
-

Three brief examples

+

Three brief examples

Here are three examples to show typical usage of pybedtools. More info can be found in the docstrings of pybedtools methods and in the Tutorial Contents.

@@ -56,7 +57,7 @@
-

Example 1: Save a BED file of intersections, with track line

+

Example 1: Save a BED file of intersections, with track line

This example saves a new BED file of intersections between your files mydata/snps.bed and mydata/exons.bed, adding a track line to the output:

>>> import pybedtools
@@ -66,7 +67,7 @@ 

Example 1: Save a BED file of intersections, with track line -

Example 2: Intersections for a 3-way Venn diagram

+

Example 2: Intersections for a 3-way Venn diagram

This example gets values for a 3-way Venn diagram of overlaps. This demonstrates operator overloading of BedTool objects. It assumes that you have the files a.bed, b.bed, and c.bed in your current working @@ -94,7 +95,7 @@

Example 2: Intersections for a 3-way Venn diagramR package.

-

Example 3: Count reads in introns and exons, in parallel

+

Example 3: Count reads in introns and exons, in parallel

This example shows how to count the number of reads in introns and exons in parallel. It is somewhat more involved, but illustrates several additional features of pybedtools such as:

@@ -190,18 +191,18 @@

Navigation

  • previous |
  • - +