Skills › Scientific Agent Skills › pacsomatic › agent-playbook.md
agent-playbook.md
31 lines · skills/pacsomatic/references/agent-playbook.md at 5f2bc03
Most marks come from matching words in the file, so treat them as pointers.
1# Operator playbook
31. Establish one true matched PacBio HiFi tumor/normal pair from acquisition
4 metadata. Require patient and sample IDs; do not invent clinical identifiers.
52. Select a reference with exact assembly, contig naming and resource provenance.
6 FASTA alone does not supply VEP, SV annotation, clonality or signature resources.
73. Prepare artifacts with the helper's `--dry-run` and `--use-current-path`.
8 Report each warning and separate file/name checks from unperformed BAM,
9 schema, network, container and scheduler checks.
104. Review `samplesheet.csv`: tumor status 1, normal status 0, same patient,
11 distinct samples/files. Confirm that optional `.pbi` indexes correspond to
12 their BAM. Confirm that MM/ML modification tags survived input processing
13 before expecting methylation results.
145. Review commit pin, params, profiles and generated shell script. Read local
15 infrastructure configuration before launch. `--executor slurm` by itself
16 does not set the task executor to Slurm. Default `config.yaml` is descriptive
17 and is not loaded by Python.
186. Execute only when requested. A new run uses `--run`; reusing generated
19 artifacts needs `--overwrite`. If using a local checkout, record git HEAD and
20 any uncommitted diff separately and omit `--pipeline-version`.
217. Return the exact artifact/script paths, run type and checked scope, requested
22 pipeline revision, submission job ID if parsed, and one next QC/triage action.
23 Do not label a queued job complete or helper dry-run as pipeline validation.
248. On failure, preserve the driver log, `.nextflow.log`, work task logs, params
25 and samplesheet. Do not delete work/cache before deciding whether to resume.
26 Keep secrets and identifiable sequencing metadata out of shared logs/reports.
28All example commands in [the main skill](../SKILL.md) use repository-root paths.
29When the skill is installed elsewhere, resolve `scripts/run_pacsomatic.py`
30relative to its skill directory; `.github/skills/pacsomatic` is not this
31repository's layout.
Operator playbook
- Establish one true matched PacBio HiFi tumor/normal pair from acquisition metadata. Require patient and sample IDs; do not invent clinical identifiers.
- Select a reference with exact assembly, contig naming and resource provenance. FASTA alone does not supply VEP, SV annotation, clonality or signature resources.
- Prepare artifacts with the helper's
--dry-runand--use-current-path. Report each warning and separate file/name checks from unperformed BAM, schema, network, container and scheduler checks. - Review
samplesheet.csv: tumor status 1, normal status 0, same patient, distinct samples/files. Confirm that optional.pbiindexes correspond to their BAM. Confirm that MM/ML modification tags survived input processing before expecting methylation results. - Review commit pin, params, profiles and generated shell script. Read local infrastructure configuration before launch.
--executor slurmby itself does not set the task executor to Slurm. Defaultconfig.yamlis descriptive and is not loaded by Python. - Execute only when requested. A new run uses
--run; reusing generated artifacts needs--overwrite. If using a local checkout, record git HEAD and any uncommitted diff separately and omit--pipeline-version. - Return the exact artifact/script paths, run type and checked scope, requested pipeline revision, submission job ID if parsed, and one next QC/triage action. Do not label a queued job complete or helper dry-run as pipeline validation.
- On failure, preserve the driver log,
.nextflow.log, work task logs, params and samplesheet. Do not delete work/cache before deciding whether to resume. Keep secrets and identifiable sequencing metadata out of shared logs/reports.
All example commands in the main skill use repository-root paths. When the skill is installed elsewhere, resolve scripts/run_pacsomatic.py relative to its skill directory; .github/skills/pacsomatic is not this repository's layout.
Runs code scripts/run_pacsomatic.py :29