Skip to content

Expand deepCSA documentation coverage and output interpretation#448

Merged
FerriolCalvet merged 4 commits into
devfrom
copilot/add-documentation-for-deepumicaller
May 27, 2026
Merged

Expand deepCSA documentation coverage and output interpretation#448
FerriolCalvet merged 4 commits into
devfrom
copilot/add-documentation-for-deepumicaller

Conversation

Copy link
Copy Markdown
Contributor

Copilot AI commented May 1, 2026

The issue called for a comprehensive documentation pass: clarify deepUMIcaller inputs, data sources, output interpretation, examples, and citation coverage while documenting toggles and QC guidance. This update focuses on filling the missing pipeline documentation gaps across usage, file formats, output interpretation, tools, and citations.

  • Inputs & data sources
    • DeepUMIcaller VCF/BAM selection guidance, batch/sample handling
    • Explicit download sources for VEP, CADD, dNdScv, Oncodrive3D, GFF3
    • NanoSeq mask usage and parameters
  • Outputs & interpretation
    • Output directory cheat sheet and PMEAN/PSTD behavior
    • QC/sanity checks, omega vs omegagloballoc, site selection metrics
    • Signature outputs and profile stability interpretation
  • Examples & formats
    • Blacklist, gene grouping, subgenic/hotspot region examples
    • Expanded file-format descriptions (CADD, dNdScv, WGS trinuc counts)
  • Tooling & provenance
    • Container image list with override guidance
    • CITATIONS expanded to cover intermediate tools and repositories

Example config snippet (from docs) showing new guidance:

params {
    nanoseq_snp   = "SNP_GRCh38.wgns.bed.gz"
    nanoseq_noise = "NOISE_GRCh38.wgns.bed.gz"
    plot_only_allsamples = true
    positive_selection_non_protein_affecting = true
}

Warning

Firewall rules blocked me from connecting to one or more addresses (expand for details)

I tried to connect to the following addresses, but was blocked by firewall rules:

  • www.protocols.io
    • Triggering command: /home/REDACTED/work/_temp/ghcca-node/node/bin/node /home/REDACTED/work/_temp/ghcca-node/node/bin/node --enable-source-maps /home/REDACTED/work/_temp/copilot-developer-action-main/dist/index.js (dns block)

If you need me to access, download, or install something from one of these locations, you can either:

Copilot AI linked an issue May 1, 2026 that may be closed by this pull request
30 tasks
Agent-Logs-Url: https://github.com/bbglab/deepCSA/sessions/c4fac4e8-2063-4a96-9fcb-5ce5b5f93ea3

Co-authored-by: FerriolCalvet <38539786+FerriolCalvet@users.noreply.github.com>
Copilot AI changed the title [WIP] Add documentation for deepUMIcaller inputs and outputs Expand deepCSA documentation coverage and output interpretation May 1, 2026
Copilot AI requested a review from FerriolCalvet May 1, 2026 14:21
Copy link
Copy Markdown
Member

@FerriolCalvet FerriolCalvet left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

looks good!

@FerriolCalvet FerriolCalvet marked this pull request as ready for review May 27, 2026 14:31
@FerriolCalvet FerriolCalvet merged commit a06c90a into dev May 27, 2026
@FerriolCalvet FerriolCalvet deleted the copilot/add-documentation-for-deepumicaller branch May 27, 2026 14:39
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Documentation needed

2 participants