Skip to content
Skills Library
Science & research · Building & coding

refdata-seqc2-workflow-profile-add

/refdata-seqc2-workflow-profile-add

Add a seqc2-toolkit workflow profile (YAML) that turns a SEQC2 dataset into the samplesheet, params.yaml/params.config and extra files of a new workflow, with accepts/requires checks, local and remote variants and a pytest. Use when a new pipeline should be tested on SEQC2 data via seqc2 samplesheet/run.

Licence
MIT
Last repository change
11.11.2026

Assessment and security

100/ 100Class: good
Format25 / 25
Frontmatter with name and description, valid name, description up to 1,024 characters, name matching the folder.
Discoverability25 / 25
Description explains when to use the skill, has a reasonable length and uses third person.
Content35 / 35
At least 150 words and at most 500 lines, headings, step lists, examples or code.
Hygiene15 / 15
No placeholders such as TODO, no Windows paths, with a licence.
Riskno signals detected in the scan
Files in this package
1
Scripts
0
HTML comments
0
URLs in SKILL.md
0
Deprecation

No signals detected. Repository changed on 11.11.2026, without references to retired models or APIs.

Licence

MIT, open: use and modify while retaining author attribution.

What it does and when to use it

Add a seqc2-toolkit workflow profile (YAML) that turns a SEQC2 dataset into the samplesheet, params.yaml/params.config and extra files of a new workflow, with accepts/requires checks, local and remote variants and a pytest. Use when a new pipeline should be tested on SEQC2 data via seqc2 samplesheet/run.

Original author description

Add a seqc2-toolkit workflow profile (YAML) that turns a SEQC2 dataset into the samplesheet, params.yaml/params.config and extra files of a new workflow, with accepts/requires checks, local and remote variants and a pytest. Use when a new pipeline should be tested on SEQC2 data via seqc2 samplesheet/run.

How it works

  1. Steps
  2. Checks before finishing
  3. Pitfalls
Original SKILL.md headings · 79 lines, 484 words
SKILL.md preview
---
name: refdata-seqc2-workflow-profile-add
description: 'Add a seqc2-toolkit workflow profile (YAML) that turns a SEQC2 dataset into the samplesheet, params.yaml/params.config and extra files of a new workflow, with accepts/requires checks, local and remote variants and a pytest. Use when a new pipeline should be tested on SEQC2 data via seqc2 samplesheet/run.'
---

# Add a seqc2-toolkit workflow profile

Purpose: everything workflow-specific stays in one profile; the toolkit stays generic.

Use when a pipeline needs SEQC2 inputs. Not for pipeline code (`nextflow`/`nf-core-*`).

## Steps

1. **Read the pipeline's input contract**: `assets/schema_input.json` (columns, required,
   patterns), `nextflow_schema.json` (params), which FORMAT fields it reads (AD, AF, DP),
   whether it needs bgzip+index, sample order, BAMs, target BED.
2. **Check the toolkit version** (`seqc2 --version`, branch): `params_remote`,
   `files_remote`, `params.config` and `--config-base` may be branch-only.
3. **Write the profile** (`src/seqc2_toolkit/profiles/<name>.yaml` to ship it, or any path
   passed with `--profile path.yaml`):

   ```yaml
   name: mypipeline
   description: one line for 'seqc2 profiles'
   pipeline: <org>/<repo>          # nextflow run target (or --pipeline)
   revision: dev                   # -r (or --revision)
   nf_profile: conda               # -profile (or --nf-profile)
   accepts: {callers: [muTect2], technologies: [WGS, WES]}  # fields the pipeline needs
   requires: [vcf, reference]      # dataset content needed
   paths: relative                 # relative: folder can be moved/committed; absolute
   samplesheet:
     file: samplesheet.csv         # follow the pipeline's format (CUBI default .tsv)
     rows: vcf                     # vcf: per VCF | pair: per pair x technology | bam: per BAM
     missing: n/a
     columns:
       sample: "SEQC2_{pair}_{tech}"
       vcf: "{vcf}"
       tumor_bam: "{tumor_bam}"
   params:
     input: "{samplesheet}"
     fasta: "{reference}"
     truth_vcf: "{truth_snv}"
   params_remote:                  # replaces params for access: remote; null drops one
     recompress_vcf: true
   files:                          # extra files: relative path -> template text
     known.csv: |
       name,variants,regions
       seqc2_truth,{truth_snv};{truth_indel},{truth_regions}
   files_remote: {known.csv: null}
   ```

   Variables: per row `pair, center, replicate, technology, tech, library_type, aligner,
   caller, vcf, tumor_bam, tumor_bai, normal_bam, normal_bai, tumor_id, normal_id,
   target_bed` (rows bam: `role, bam, bai`); per dataset `dataset, dataset_dir, workdir,
   samplesheet, pairs, first_pair, all_bams, access, contigs, reference, reference_fai,
   target_bed_wes, truth_snv, truth_indel, truth_regions, gencode_gtf, giab_<name>`.
   An empty variable gives `missing` in a column, drops a param, and is an error in a file.
   Check the list in the toolkit README of the version in use.
4. **Render and inspect**: `seqc2 samplesheet <dataset.yaml> --profile <name> --outdir <dir>`;
   read the generated samplesheet/params (they hold paths, not genomic records).
5. **Dry run**: `seqc2 run <dataset.yaml> --profile <name> --pipeline <path> --dry-run`, then a
   real run on a T1 dataset; extra nextflow args after `--`.
6. **Test**: add a case to `tests/test_profiles.py` (renders with a fake `dataset.json`,
   checks columns, `accepts`/`requires` errors, remote variant); `pytest`, `black`, `ruff`.
7. **Pipeline side** (hand to `nextflow`/`nf-core-testing`): `conf/test*.config` with
   `includeConfig '../assets/seqc2/test/params.config'` or `--pipelines_testdata_base_path`.
8. Document the profile in the toolkit README and CHANGELOG.

## Checks before finishing

- `seqc2 profiles` lists it; shipped profile loads in `test_shipped_profiles_load`.
- Samplesheet validates against the pipeline schema (nf-schema run or `-stub`).
- Remote and local variants both render, or `accepts` excludes the unsupported one.

## Pitfalls

- MuTect2 3.8 VCFs: no FORMAT/DP, AF can be `nan`; pipelines reading DP need
  `vcf.format_dp: true` in the dataset; position-indexed sample filters need `sample_order`.
- Remote VCFs are plain gzip with all contigs: pipeline must recompress and filter.
- Strelka/SomaticSniper lack AD/AF: restrict `accepts.callers` instead of failing later.
- Do not add workflow-specific code to the toolkit; extend the template variables only when
  generic.

Versions

The database has no other skills named refdata-seqc2-workflow-profile-add.

Database snapshot: 13.11.2026 · package version 86bc205186c4 (SHA-256 digest of the entire package)

Downloads in the last 30 days: 0 · ranking

Report a problem with this skill: harmful content, incorrect descriptions or an author’s removal request.

Similar skills

  • 100refdata-seqc2-dataset-prepare
    Download and build a SEQC2 (HCC1395/HCC1395BL) dataset folder with seqc2-toolkit: dataset config, seqc2 plan/fetch/verify, md5-checked cache, VCF/BAM/reference/truth/GENCODE/GIAB stratification files. Use when a workflow test needs SEQC2 data on disk or as remote URLs.
  • 100refdata-offline-transfer
    Prepare SEQC2/GIAB reference test data on a machine with internet and move it to an offline HPC: seqc2 fetch, checksums, relocatable samplesheets/params (config-base, pipelines_testdata_base_path), test_full_offline profile, transfer bundle and verification after the copy. Use…
  • 95bio-workflow-management-nf-core-pipelines
    Runs and configures curated nf-core community Nextflow pipelines (rnaseq, sarek, atacseq, methylseq, ampliseq, taxprofiler, fetchngs) reproducibly, pinning the pipeline revision with -r and selecting a container engine and institutional config via -profile. Use when deciding to…

Feedback and reports

Your message goes to Bartosz Sokoliński. An email address is needed only for a reply. See the privacy policy.