Repository navigation
Command Line Interface
A thin CLI wraps the setup steps in Configuration Reference
so you don't have to assemble input/config.yaml and input/samples.csv by
hand — it creates the same two gitignored files and then launches snakemake,
so the workflow itself is unchanged. Run it with the project's Python (the
env ships PyYAML):
python workflow/scripts/tetranscripts-pipe --version # echoes the release from VERSION
python workflow/scripts/tetranscripts-pipe --help # lists the subcommandsThree subcommands:
-
init— copiesconfig/config.example.yamlandconfig/samples.example.csvintoinput/(refuses to overwrite unless--force). Same as the manualcpsteps in Configuration Reference, for starting a fresh analysis. -
samples --reads DIR— scans a fastq directory (recursively) and writes a schema-validinput/samples.csv._R1/_R2(or_1/_2) files pair up; a lone_R1is written as single-end; unmarked files become single-end rows;_L00Nlanes and_001chunks collapse into repeated rows for the same sample — exactly the nf-core lane merging the workflow'scat_fastqstep expects. It fails loudly on R2-without-R1 and on mixed paired/single-end lanes for one sample.--dry-runprints the sheet to stdout instead of writing it. -
run— generatesinput/config.yamlfrom the example template when missing (with--fasta/--gtf/--te-gtffilling in the reference paths) and the sample sheet from--readswhen missing, then runs snakemake:python workflow/scripts/tetranscripts-pipe run \ --reads /data/fastq \ --fasta /refs/genome.fa --gtf /refs/genome.gtf --te-gtf /refs/TE_curated.gtf \ --cores 32 python workflow/scripts/tetranscripts-pipe run --dry-run --reads /data/fastq # just print the plan python workflow/scripts/tetranscripts-pipe run --profile workflow/profiles/slurm --cores 64An existing
input/config.yaml/input/samples.csvis used as-is, so your hand-edits survive;--forceregenerates them.--profile(e.g. the bundledworkflow/profiles/slurm),--cores,--snakemake-argsand--keep-tempare passed through to snakemake.Once your config exists and already points at a sample sheet (its
samples:key), no other options are needed —runreads the sheet path straight from the config (resolved repo-root-relative, exactly like snakemake does):python workflow/scripts/tetranscripts-pipe run --config input/config.yaml --cores 32
Relative paths inside a config always resolve against the repo checkout that contains the config (its
workflow/Snakefileancestor), and snakemake is launched from that same root. So the CLI can be installed in a different checkout than the analysis — e.g. a sharedapps/copy running a config in an analysis working copy:python /software/TEtranscripts-pipe/workflow/scripts/tetranscripts-pipe \ run --config /data/projects/rnaseq/TEtranscripts-pipe/input/config.yaml --cores 32
--samplesheetstill takes precedence for the CLI's own existence check, but with an existing config snakemake always reads the config'ssamples:path — the flag is authoritative only when the config is scaffolded (or regenerated with--force).