Command line interface reference
BEDboss is command-line tool-manager and a set of tools for working with BED files and BEDbase. Main components of BEDboss are:
- Pipeline for processing BED files: bedmaker, bedqc, and bedstats.
- Indexing of the Bed files in bedbase
- Managing bed and bedsets in the database
Here you can see the command-line usage instructions for the main bedboss command and for each subcommand:
bedboss --help
Section titled โbedboss --helpโ Usage: bedboss [OPTIONS] COMMAND [ARGS]...
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ --version -v App version โโ --install-completion Install completion for the current shell. โโ --show-completion Show completion for the current shell, to copy it or โโ customize the installation. โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏโญโ Commands โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ run-all Run all the bedboss pipeline for a single bed file โโ run-pep Run the all bedboss pipeline for a bed files in a PEP โโ reprocess-all Run unprocessed files, or reprocess them โโ reprocess-one Run unprocessed file, or reprocess it [Only 1 file] โโ reprocess-bedset Reprocess a bedset โโ make-bed Create a bed files form a [bigwig, bedgraph, bed, bigbed, โโ wig] file โโ make-bigbed Create a bigbed files form a bed file โโ run-qc Run the quality control for a bed file โโ run-stats Create the statistics for a single bed file. โโ reindex Reindex the bedbase database and insert all files to the โโ qdrant database. โโ make-bedset Create a bedset from a pep file, and insert it to the bedbase โโ database. โโ init-config Initialize the new, sample configuration file โโ delete-bed Delete bed from the bedbase database โโ delete-bedset Delete BedSet from the bedbase database โโ tokenize-bed Tokenize a bedfile โโ delete-tokenized Delete tokenized bed file โโ convert-universe Convert bed file to universe โโ check-requirements Check installed R packages โโ install-requirements Install R dependencies โโ verify-config Verify configuration file โโ geo Automatic BEDbase uploader for GEO data โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss geo --help
Section titled โbedboss geo --helpโ Usage: bedboss geo [OPTIONS] COMMAND [ARGS]...
Automatic BEDbase uploader for GEO data
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ --version -v App version โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏโญโ Commands โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ upload-all Run bedboss uploading pipeline for specified genome in specified period โโ of time. โโ upload-gse Run bedboss uploading pipeline for GSE. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss geo upload-all --help
Section titled โbedboss geo upload-all --helpโ Usage: bedboss geo upload-all [OPTIONS]
Run bedboss uploading pipeline for specified genome in specified period of time.
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bedbase-config TEXT Path to bedbase config โโ file โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to output folder โโ [default: None] โโ [required] โโ --start-date TEXT The earliest date when โโ opep was updated โโ [Default: 2000/01/01] โโ [default: None] โโ --end-date TEXT The latest date when opep โโ was updated [Default: โโ today's date] โโ [default: None] โโ --search-limit INTEGER Limit of projects to be โโ searched. [Default: 50] โโ [default: 50] โโ --search-offset INTEGER Limit of projects to be โโ searched. [Default: 0] โโ [default: 0] โโ --download-limit INTEGER Limit of projects to be โโ downloaded [Default: 100] โโ [default: 100] โโ --genome TEXT Reference genome โโ [Default: None] (e.g. โโ hg38) - if None, all โโ genomes will be processed โโ [default: None] โโ --preload --no-preload Download bedfile before โโ caching it. [Default: โโ True] โโ [default: preload] โโ --create-bedset --no-create-bedset Create bedset from bed โโ files. [Default: True] โโ [default: create-bedset] โโ --overwrite --no-overwrite Overwrite existing โโ bedfiles. [Default: โโ False] โโ [default: no-overwrite] โโ --overwrite-bedset --no-overwrite-bedset Overwrite existing โโ bedset. [Default: False] โโ [default: โโ overwrite-bedset] โโ --rerun --no-rerun Re-run all the samples. โโ [Default: False] โโ [default: no-rerun] โโ --run-skipped --no-run-skipped Run skipped projects. โโ [Default: False] โโ [default: run-skipped] โโ --run-failed --no-run-failed Run failed projects. โโ [Default: False] โโ [default: run-failed] โโ --standardize-pep --no-standardize-pep Standardize pep with โโ BEDMESS. [Default: False] โโ [default: โโ no-standardize-pep] โโ --use-skipper --no-use-skipper Use skipper to skip โโ projects if they were โโ processed locally โโ [Default: False] โโ [default: no-use-skipper] โโ --reinit-skipper --no-reinit-skipper Reinitialize skipper. โโ [Default: False] โโ [default: โโ no-reinit-skipper] โโ --lite --no-lite Run the pipeline in lite โโ mode. [Default: False] โโ [default: no-lite] โโ --help Show this message and โโ exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss geo upload-gse --help
Section titled โbedboss geo upload-gse --helpโ Usage: bedboss geo upload-gse [OPTIONS]
Run bedboss uploading pipeline for GSE.
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bedbase-config TEXT Path to bedbase config file โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to output folder โโ [default: None] โโ [required] โโ * --gse TEXT GSE number that can be found โโ in pephub. eg. GSE123456 โโ [default: None] โโ [required] โโ --create-bedset --no-create-bedset Create bedset from bed โโ files. [Default: True] โโ [default: create-bedset] โโ --genome TEXT reference genome to upload โโ to database. If None, all โโ genomes will be processed โโ [default: None] โโ --preload --no-preload Download bedfile before โโ caching it. [Default: True] โโ [default: preload] โโ --rerun --no-rerun Re-run all the samples. โโ [Default: False] โโ [default: rerun] โโ --run-skipped --no-run-skipped Run skipped projects. โโ [Default: False] โโ [default: run-skipped] โโ --run-failed --no-run-failed Run failed projects. โโ [Default: False] โโ [default: run-failed] โโ --overwrite --no-overwrite Overwrite existing bedfiles. โโ [Default: False] โโ [default: no-overwrite] โโ --overwrite-bedset --no-overwrite-bedset Overwrite existing bedset. โโ [Default: False] โโ [default: overwrite-bedset] โโ --standardize-pep --no-standardize-pep Standardize pep with โโ BEDMESS. [Default: False] โโ [default: โโ no-standardize-pep] โโ --use-skipper --no-use-skipper Use local skipper to skip โโ projects if they were โโ processed locally [Default: โโ False] โโ [default: no-use-skipper] โโ --reinit-skipper --no-reinit-skipper Reinitialize skipper. โโ [Default: False] โโ [default: no-reinit-skipper] โโ --lite --no-lite Run the pipeline in lite โโ mode. [Default: False] โโ [default: no-lite] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss run-all --help
Section titled โbedboss run-all --helpโ Usage: bedboss run-all [OPTIONS]
Run all the bedboss pipeline for a single bed file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --input-file TEXT Path to the input file โโ [default: None] โโ [required] โโ * --input-type TEXT Type of the input file. โโ Options are: bigwig, โโ bedgraph, bed, bigbed, wig โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ * --genome TEXT Genome name. Example: โโ 'hg38' โโ [default: None] โโ [required] โโ * --bedbase-config TEXT Path to the bedbase config โโ file โโ [default: None] โโ [required] โโ --license-id TEXT License ID. If not provided โโ for in PEPfor each bed โโ file, this license will be โโ used โโ [default: DUO:0000042] โโ --rfg-config TEXT Path to the rfg config file โโ [default: None] โโ --narrowpeak --no-narrowpeak Is the input file a โโ narrowpeak file? โโ [default: no-narrowpeak] โโ --check-qc --no-check-qc Check the quality of the โโ input file? โโ [default: check-qc] โโ --chrom-sizes TEXT Path to the chrom sizes โโ file โโ [default: None] โโ --open-signal-matrix TEXT Path to the open signal โโ matrix file โโ [default: None] โโ --ensdb TEXT Path to the EnsDb database โโ file โโ [default: None] โโ --just-db-commit --no-just-db-commit Just commit to the โโ database? โโ [default: โโ no-just-db-commit] โโ --force-overwrite --no-force-overwrite Force overwrite the output โโ files โโ [default: โโ no-force-overwrite] โโ --update --no-update Update the bedbase database โโ with the new record if it โโ exists. This overwrites โโ 'force_overwrite' option โโ [default: no-update] โโ --lite --no-lite Run the pipeline in lite โโ mode. [Default: False] โโ [default: no-lite] โโ --upload-qdrant --no-upload-qdrant Upload to Qdrant โโ [default: no-upload-qdrant] โโ --upload-s3 --no-upload-s3 Upload to S3 โโ [default: no-upload-s3] โโ --upload-pephub --no-upload-pephub Upload to PEPHub โโ [default: no-upload-pephub] โโ --universe --no-universe Create a universe โโ [default: no-universe] โโ --universe-method TEXT Method used to create the โโ universe โโ [default: None] โโ --universe-bedset TEXT Bedset used used to create โโ the universe โโ [default: None] โโ --multi --no-multi Run multiple samples โโ [default: no-multi] โโ --recover --no-recover Recover from previous run โโ [default: recover] โโ --dirty --no-dirty Run without removing โโ existing files โโ [default: no-dirty] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss run-pep --help
Section titled โbedboss run-pep --helpโ Usage: bedboss run-pep [OPTIONS]
Run the all bedboss pipeline for a bed files in a PEP
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --pep TEXT PEP file. Local or remote path โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ * --bedbase-config TEXT Path to the bedbase config โโ file โโ [default: None] โโ [required] โโ --create-bedset --no-create-bedset Create a new bedset โโ [default: create-bedset] โโ --bedset-heavy --no-bedset-heavy Run the heavy version of the โโ bedbuncher pipeline โโ [default: no-bedset-heavy] โโ --bedset-id TEXT Bedset ID [default: None] โโ --rfg-config TEXT Path to the rfg config file โโ [default: None] โโ --check-qc --no-check-qc Check the quality of the input โโ file? โโ [default: check-qc] โโ --ensdb TEXT Path to the EnsDb database โโ file โโ [default: None] โโ --just-db-commit --no-just-db-commit Just commit to the database? โโ [default: no-just-db-commit] โโ --force-overwrite --no-force-overwrite Force overwrite the output โโ files โโ [default: no-force-overwrite] โโ --update --no-update Update the bedbase database โโ with the new record if it โโ exists. This overwrites โโ 'force_overwrite' option โโ [default: no-update] โโ --upload-qdrant --no-upload-qdrant Upload to Qdrant โโ [default: upload-qdrant] โโ --upload-s3 --no-upload-s3 Upload to S3 โโ [default: upload-s3] โโ --upload-pephub --no-upload-pephub Upload to PEPHub โโ [default: upload-pephub] โโ --no-fail --no-no-fail Do not fail on error โโ [default: no-no-fail] โโ --license-id TEXT License ID โโ [default: DUO:0000042] โโ --standardize-pep --no-standardize-pep Standardize the PEP using โโ bedMS โโ [default: no-standardize-pep] โโ --lite --no-lite Run the pipeline in lite mode. โโ [Default: False] โโ [default: no-lite] โโ --rerun --no-rerun Rerun already processed โโ samples โโ [default: no-rerun] โโ --multi --no-multi Run multiple samples โโ [default: no-multi] โโ --recover --no-recover Recover from previous run โโ [default: recover] โโ --dirty --no-dirty Run without removing existing โโ files โโ [default: no-dirty] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss reprocess-all --help
Section titled โbedboss reprocess-all --helpโ Usage: bedboss reprocess-all [OPTIONS]
Run unprocessed files, or reprocess them
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bedbase-config TEXT Path to the bedbase config file โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ --limit INTEGER Limit the number of files to โโ reprocess โโ [default: 100] โโ --no-fail --no-no-fail Do not fail on error โโ [default: no-fail] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss reprocess-one --help
Section titled โbedboss reprocess-one --helpโ Usage: bedboss reprocess-one [OPTIONS]
Run unprocessed file, or reprocess it [Only 1 file]
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bedbase-config TEXT Path to the bedbase config file [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder [default: None] โโ [required] โโ * --identifier TEXT Identifier of the bed file [default: None] โโ [required] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss reprocess-bedset --help
Section titled โbedboss reprocess-bedset --helpโ Usage: bedboss reprocess-bedset [OPTIONS]
Reprocess a bedset
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bedbase-config TEXT Path to the bedbase config file โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ * --identifier TEXT Bedset ID [default: None] [required] โโ --no-fail --no-no-fail Do not fail on error [default: no-fail] โโ --heavy --no-heavy Run the heavy version of the pipeline โโ [default: no-heavy] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss make-bed --help
Section titled โbedboss make-bed --helpโ Usage: bedboss make-bed [OPTIONS]
Create a bed files form a [bigwig, bedgraph, bed, bigbed, wig] file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --input-file TEXT Path to the input file [default: None] โโ [required] โโ * --input-type TEXT Type of the input file. Options are: โโ bigwig, bedgraph, bed, bigbed, wig โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ * --genome TEXT Genome name. Example: 'hg38' โโ [default: None] โโ [required] โโ --rfg-config TEXT Path to the rfg config file โโ [default: None] โโ --narrowpeak --no-narrowpeak Is the input file a narrowpeak file? โโ [default: no-narrowpeak] โโ --chrom-sizes TEXT Path to the chrom sizes file โโ [default: None] โโ --multi --no-multi Run multiple samples โโ [default: no-multi] โโ --recover --no-recover Recover from previous run โโ [default: recover] โโ --dirty --no-dirty Run without removing existing files โโ [default: no-dirty] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss make-bigbed --help
Section titled โbedboss make-bigbed --helpโ Usage: bedboss make-bigbed [OPTIONS]
Create a bigbed files form a bed file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bed-file TEXT Path to the input file [default: None] โโ [required] โโ * --bed-type TEXT bed type to be used for bigBed file โโ generation 'bed{bedtype}+{n}' [Default: โโ None] (e.g bed3+1) โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder [default: None] โโ [required] โโ * --genome TEXT Genome name. Example: 'hg38' โโ [default: None] โโ [required] โโ --rfg-config TEXT Path to the rfg config file โโ [default: None] โโ --chrom-sizes TEXT Path to the chrom sizes file โโ [default: None] โโ --multi --no-multi Run multiple samples [default: no-multi] โโ --recover --no-recover Recover from previous run โโ [default: recover] โโ --dirty --no-dirty Run without removing existing files โโ [default: no-dirty] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss run-qc --help
Section titled โbedboss run-qc --helpโ Usage: bedboss run-qc [OPTIONS]
Run the quality control for a bed file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bed-file TEXT Path to the bed file to check the โโ quality control on. โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ --max-file-size INTEGER Maximum file size threshold to โโ pass the quality โโ [default: 2147483648] โโ --max-region-number INTEGER Maximum number of regions โโ threshold to pass the quality โโ [default: 5000000] โโ --min-region-width INTEGER Minimum region width threshold to โโ pass the quality โโ [default: 10] โโ --multi --no-multi Run multiple samples โโ [default: no-multi] โโ --recover --no-recover Recover from previous run โโ [default: recover] โโ --dirty --no-dirty Run without removing existing โโ files โโ [default: no-dirty] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss run-stats --help
Section titled โbedboss run-stats --helpโ Usage: bedboss run-stats [OPTIONS]
Create the statistics for a single bed file.
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bed-file TEXT Path to the bed file โโ [default: None] โโ [required] โโ * --genome TEXT Genome name. Example: 'hg38' โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ --ensdb TEXT Path to the EnsDb database โโ file โโ [default: None] โโ --open-signal-matrix TEXT Path to the open signal โโ matrix file โโ [default: None] โโ --just-db-commit --no-just-db-commit Just commit to the database? โโ [default: no-just-db-commit] โโ --multi --no-multi Run multiple samples โโ [default: no-multi] โโ --recover --no-recover Recover from previous run โโ [default: recover] โโ --dirty --no-dirty Run without removing โโ existing files โโ [default: no-dirty] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss reindex --help
Section titled โbedboss reindex --helpโ Usage: bedboss reindex [OPTIONS]
Reindex the bedbase database and insert all files to the qdrant database.
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bedbase-config TEXT Path to the bedbase config file [default: None] โโ [required] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss make-bedset --help
Section titled โbedboss make-bedset --helpโ Usage: bedboss make-bedset [OPTIONS]
Create a bedset from a pep file, and insert it to the bedbase database.
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --pep TEXT PEP file. Local or remote path โโ [default: None] โโ [required] โโ * --outfolder TEXT Path to the output folder โโ [default: None] โโ [required] โโ * --bedbase-config TEXT Path to the bedbase config โโ file โโ [default: None] โโ [required] โโ * --bedset-name TEXT Name of the bedset โโ [default: None] โโ [required] โโ --heavy --no-heavy Run the heavy version of the โโ pipeline โโ [default: no-heavy] โโ --force-overwrite --no-force-overwrite Force overwrite the output โโ files โโ [default: no-force-overwrite] โโ --upload-s3 --no-upload-s3 Upload to S3 โโ [default: no-upload-s3] โโ --upload-pephub --no-upload-pephub Upload to PEPHub โโ [default: no-upload-pephub] โโ --no-fail --no-no-fail Do not fail on error โโ [default: no-no-fail] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss init-config --help
Section titled โbedboss init-config --helpโ Usage: bedboss init-config [OPTIONS]
Initialize the new, sample configuration file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --outfolder TEXT Path to the output folder [default: None] [required] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss delete-bed --help
Section titled โbedboss delete-bed --helpโ Usage: bedboss delete-bed [OPTIONS]
Delete bed from the bedbase database
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --sample-id TEXT Sample ID [default: None] [required] โโ * --config TEXT Path to the bedbase config file [default: None] โโ [required] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss delete-bedset --help
Section titled โbedboss delete-bedset --helpโ Usage: bedboss delete-bedset [OPTIONS]
Delete BedSet from the bedbase database
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --identifier TEXT BedSet ID [default: None] [required] โโ * --config TEXT Path to the bedbase config file [default: None] โโ [required] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss tokenize-bed --help
Section titled โbedboss tokenize-bed --helpโ Usage: bedboss tokenize-bed [OPTIONS]
Tokenize a bedfile
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bed-id TEXT Path to the bed file [default: None] โโ [required] โโ * --universe-id TEXT Universe ID [default: None] โโ [required] โโ --cache-folder TEXT Path to the cache folder โโ [default: None] โโ --add-to-db --no-add-to-db Add the tokenized bed file to the โโ bedbase database โโ [default: no-add-to-db] โโ --bedbase-config TEXT Path to the bedbase config file โโ [default: None] โโ --overwrite --no-overwrite Overwrite the existing tokenized bed โโ file โโ [default: no-overwrite] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss delete-tokenized --help
Section titled โbedboss delete-tokenized --helpโ Usage: bedboss delete-tokenized [OPTIONS]
Delete tokenized bed file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --universe-id TEXT Universe ID [default: None] [required] โโ * --bed-id TEXT Bed ID [default: None] [required] โโ --config TEXT Path to the bedbase config file [default: None] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss convert-universe --help
Section titled โbedboss convert-universe --helpโ Usage: bedboss convert-universe [OPTIONS]
Convert bed file to universe
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --bed-id TEXT Path to the bed file [default: None] [required] โโ * --config TEXT Path to the bedbase config file [default: None] [required] โโ --method TEXT Method used to create the universe [default: None] โโ --bedset TEXT Bedset used to create the universe [default: None] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss check-requirements --help
Section titled โbedboss check-requirements --helpโ Usage: bedboss check-requirements [OPTIONS]
Check installed R packages
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss install-requirements --help
Section titled โbedboss install-requirements --helpโ Usage: bedboss install-requirements [OPTIONS]
Install R dependencies
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss verify-config --help
Section titled โbedboss verify-config --helpโ Usage: bedboss verify-config [OPTIONS]
Verify configuration file
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ * --config TEXT Path to the bedbase config file [default: None] [required] โโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏbedboss get-commands --help
Section titled โbedboss get-commands --helpโ Usage: bedboss get-commands [OPTIONS]
Get available commands
โญโ Options โโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฎโ --help Show this message and exit. โโฐโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโโฏ