Snakemake
v6.13.1

Getting started

  • Installation
  • Snakemake Tutorial
  • Short tutorial
  • Snakemake Executor Tutorials
  • Best practices

Executing workflows

  • Command line interface
  • Cluster Execution
  • Cloud execution
  • Job Grouping
  • Between workflow caching
  • Interoperability
  • Monitoring

Defining workflows

  • Writing Workflows
  • Snakefiles and Rules
  • Configuration
  • Modularization
  • Remote files
  • Utils
  • Distribution and Reproducibility
  • Reports
  • Automatically generating unit tests
  • Integrating foreign workflow management systems

API Reference

  • The Snakemake API
  • Additional utils
  • Internal API
    • snakemake package

Project Info

  • Citing and Citations
  • More Resources
  • Frequently Asked Questions
  • Contributing
  • Credits
  • Changelog
  • License
Snakemake
  • Docs »
  • Internal API
  • Edit on GitHub

Internal APIΒΆ

These pages document the entire internal API of Snakemake.

  • snakemake package
    • Subpackages
      • snakemake.remote package
        • Submodules
        • snakemake.remote.EGA module
        • snakemake.remote.FTP module
        • snakemake.remote.GS module
        • snakemake.remote.HTTP module
        • snakemake.remote.NCBI module
        • snakemake.remote.S3 module
        • snakemake.remote.S3Mocked module
        • snakemake.remote.SFTP module
        • snakemake.remote.XRootD module
        • snakemake.remote.dropbox module
        • snakemake.remote.gfal module
        • snakemake.remote.gridftp module
        • snakemake.remote.iRODS module
        • snakemake.remote.webdav module
        • Module contents
      • snakemake.report package
        • Module contents
    • Submodules
    • snakemake.benchmark module
    • snakemake.checkpoints module
    • snakemake.common module
    • snakemake.conda module
    • snakemake.cwl module
    • snakemake.dag module
    • snakemake.decorators module
    • snakemake.exceptions module
    • snakemake.executors module
    • snakemake.gui module
    • snakemake.io module
    • snakemake.jobs module
    • snakemake.logging module
    • snakemake.output_index module
    • snakemake.parser module
    • snakemake.persistence module
    • snakemake.rules module
    • snakemake.scheduler module
    • snakemake.script module
    • snakemake.shell module
    • snakemake.singularity module
    • snakemake.stats module
    • snakemake.utils module
    • snakemake.workflow module
    • snakemake.wrapper module
    • Module contents
Next Previous

© Copyright 2014-2021, Johannes Koester Revision 9fe8060b.

Built with Sphinx using a theme provided by Read the Docs.
Read the Docs v: v6.13.1
Versions
master
latest
stable
v6.13.1
v6.13.0
v6.12.3
v6.12.2
v6.12.1
v6.12.0
v6.11.1
v6.11.0
v6.10.0
v6.9.1
v6.9.0
v6.8.2
v6.8.1
v6.8.0
v6.7.0
v6.6.1
v6.6.0
v6.5.5
v6.5.4
v6.5.3
v6.5.2
v6.5.1
v6.5.0
v6.4.1
v6.4.0
v6.3.0
v6.2.1
v6.2.0
v6.1.2
v6.1.1
v6.1.0
v6.0.5
v6.0.4
v6.0.3
v6.0.2
v6.0.1
v6.0.0
v5.32.2
v5.32.1
v5.32.0
v5.31.1
v5.31.0
v5.30.2
v5.30.1
v5.30.0
v5.29.0
v5.28.0
v5.27.4
v5.27.3
v5.27.2
v5.27.1
v5.27.0
v5.26.1
v5.26.0
v5.25.0
v5.24.2
v5.24.1
v5.24.0
v5.23.0
v5.22.1
v5.22.0
v5.21.0
v5.20.1
v5.20.0
v5.19.3
v5.19.2
v5.19.1
v5.19.0
v5.18.1
v5.18.0
v5.17.0
v5.16.0
v5.15.0
v5.14.0
v5.13.0
v5.12.3
v5.12.2
v5.12.1
v5.12.0
v5.11.2
v5.11.1
v5.11.0
v5.10.0
v5.9.1
v5.9.0
v5.8.2
v5.8.1
v5.8.0
v5.7.4
v5.7.3
v5.7.2
v5.7.1
v5.7.0
v5.6.0
v5.5.4
v5.5.3
v5.5.2
v5.5.1
v5.5.0
v5.4.5
v5.4.4
v5.4.3
v5.4.2
v5.4.1
v5.4.0
v5.3.1
v5.3.0
v5.2.4
v5.2.3
v5.2.2
v5.2.1
v5.2.0
v5.1.5
v5.1.4
v5.1.3
v5.1.2
v5.1.1
v5.0.0
v4.8.1
v4.8.0
v4.7.0
v4.6.0
v4.5.1
v4.5.0
v4.3.0
v4.2.0
v4.1.0
v4.0.0
v3.13.3
v3.13.2
v3.13.1
v3.13.0
v3.12.0
v3.11.2
v3.11.1
v3.11.0
v3.10.2
v3.10.1
v3.10.0
v3.9.1
v3.9.0
v3.7.1
Downloads
On Read the Docs
Project Home
Builds

Free document hosting provided by Read the Docs.