package bistro

You can search for identifiers within the package.

in-package search v0.2.0

package bistro

bistro
- Bistro
  - Private
  - Shell_dsl
  - Template_dsl
  - Workflow
  - binary_file
  - bz2
  - directory
  - file
  - gz
  - html
  - pdf
  - png
  - sexp_value
  - svg
  - tar
  - text_file
  - tsv
  - zip
bistro.bioinfo
- Bistro_bioinfo
  - Bed
  - Bedtools
    
    Cmd
  - Bowtie
    
    index
  - Bowtie2
    
    index
  - ChIPQC
    
    output
  - Cisa
  - DESeq2
    
    table
  - Deeptools
    
    compressed_numpy_array
    
    deeptools_matrix
  - Ensembl
  - FastQC
    
    report
  - Fastq
  - Fastq_screen
    
    output
  - Hisat2
  - Htseq
    
    count_tsv
  - Idba
  - Idr
  - Kallisto
    
    abundance_table
    
    index
  - Macs
    
    narrow_peaks
    
    output
    
    peak_summits
    
    peaks_xls
  - Macs2
    
    broad_output
    
    broad_peaks
    
    narrow_output
    
    narrow_peaks
    
    output
    
    peak_summits
    
    peaks_xls
  - Meme_suite
  - Picardtools
  - Prokka
  - Quast
  - Samtools
  - Spades
  - Sra_toolkit
  - Srst2
  - Star
  - Subread
    
    count_table
  - Tophat
    
    output
  - Ucsc_gb
    
    Lift_over
    
    chain_file
    
    output
    
    bedGraph
    
    bigBed
    
    bigWig
    
    chrom_sizes
    
    chromosome_sequences
    
    twobit
    
    wig
  - bam
  - bed3
  - bed4
  - bed5
  - bed6
  - fasta
  - fastq
  - gff
  - gff2
  - gff3
  - indexed_bam
  - phred64_fastq
  - sam
  - sanger_fastq
  - solexa_fastq
  - sra
bistro.engine
- Bistro_engine
  - Allocator
  - Db
  - Docker
  - Eval_thread
    
    Infix
  - Execution_env
  - Execution_trace
  - Local_backend
  - Logger
    
    t
  - Lwt_queue
  - Misc
  - Path
  - Scheduler
    
    Backend
    
    Gc
    
    Make
    
    Backend
  - Shell_command
  - Singularity
  - Task_result
bistro.internals
- Bistro_internals
  - Command
    
    Docker_image
    
    Singularity_image
  - Template
  - Workflow
    
    Any
    
    Map
    
    Set
    
    Table
bistro.multinode
- Bistro_multinode
  - Client
  - Server
bistro.nlp
- Bistro_nlp
  - Stanford_parser
    
    deps
bistro.unix
- Bistro_unix
  - Cmd
bistro.utils
- Bistro_utils

Legend:
Library
Module
Module type
Parameter
Class
Class type

A database to cache workflow result and execution traces

It is implemented as a directory in the file system.

type t

An abstract type for databases

type id = string

val init : string -> (t, [ `Msg of string ]) Stdlib.result

init path creates a database located at path path, which can be absolute or relative. If the path already exists, its contents is inspected to see if it looks like a bistro database; if not, a fresh database is created on the filesystem.

Returns an error message if path is occupied with something else than a bistro database.

val init_exn : string -> t

raises Failure

val tmp_dir : t -> string

val cache_dir : t -> string

val stdout_dir : t -> string

val stderr_dir : t -> string

val build_dir : t -> string

val singularity_image_dir : t -> string

val tmp : t -> id -> string

val cache : t -> id -> string

val stdout : t -> id -> string

val stderr : t -> id -> string

val build : t -> id -> string

val singularity_image : t -> Bistro_internals.Command.container_image -> string

val container_image_identifier : 
  Bistro_internals.Command.container_image ->
  string

val fold_cache : t -> init:'a -> f:('a -> string -> 'a) -> 'a

val path : t -> Bistro_internals.Workflow.path -> string

val is_in_cache : t -> Bistro_internals.Workflow.any -> bool