Skip to content

README edits - #4

Merged
alex-sandercock merged 1 commit into
developmentfrom
readme-trim
Nov 16, 2026
Merged

alex-sandercock merged 1 commit into
developmentfrom
readme-trim

Conversation

@alex-sandercock

Copy link
Copy Markdown
Contributor

Summary

A shorter README, 1,161 words against 1,309. Only README.md changes.

  • Repetition removed. The platforms, the lack of dependencies and the HapApp route were each given two or three times. Highlights loses the two bullets the introduction already covers.
  • Sections that repeated the docs. Installation keeps the PyPI route and links the installation page for binaries, pipx and a clone. Quick Start keeps the main route and links the tutorials for the others. Input Formats and Output become one paragraph with links.
  • What a MADC is. The introduction now says what a MADC table holds and why microhaplotypes matter, and links Breeding Insight's "What is a MADC file?" page at the first mention.
  • What happens to the table. HapApp assigns fixed allele IDs for building a microhaplotype database and comparing sequencing runs. A MADC converts to a VCF of SNP genotype calls with BIGr and updog after HapApp, or with madcats call straight from the raw table.
  • Experimental marking. call and filter-paralogs are marked experimental in the introduction, Highlights and the Commands table.

The platforms, the lack of dependencies and the HapApp route were each
given two or three times, and the input and output sections repeated the
documentation.  The Highlights lose the two bullets the introduction
already covers.  Installation keeps the PyPI route and points to the
installation page for binaries, pipx and a clone.  Quick Start keeps the
main route and links the tutorials for the others.  Input Formats and
Output become one paragraph with links.

The introduction now says what a MADC table holds and why microhaplotypes
matter, and links Breeding Insight's "What is a MADC file?" page at the
first mention.  It says what HapApp is for, which is fixed allele IDs for
a microhaplotype database and for comparing sequencing runs, and that a
MADC converts to a VCF of SNP genotype calls with BIGr and updog or with
call.  call and filter-paralogs are marked experimental.

1,309 words to 1,161.
@alex-sandercock alex-sandercock self-assigned this Nov 16, 2026
Copilot AI balanced review requested due to automatic review settings November 16, 2026 00:34
@alex-sandercock
alex-sandercock merged commit 7e49486 into development Nov 16, 2026
16 checks passed
@alex-sandercock
alex-sandercock deleted the readme-trim branch November 16, 2026 00:34

Copilot AI left a comment

Copy link
Copy Markdown

Choose a reason for hiding this comment

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

🟡 Changes recommended

The README misleadingly implies exhaustive raw-sequence counts and fails to clarify that the variants sidecar is produced only with --annotations on.

2 open issues
What changed in this PR

Shortens the README while clarifying MADCATS’ role in generating microhaplotype count tables and supporting downstream genotype calling. No application code changes.

Changes:

  • Expands the MADC explanation and clarifies the HapApp and direct-calling routes.
  • Replaces repeated installation, workflow, and format details with documentation links.
  • Marks call and filter-paralogs as experimental.
File Description
README.md Streamlines introductory guidance, clarifies downstream workflows, and adds experimental labels.

Review effort: Balanced

Comment thread README.md
Comment on lines +12 to +15
tables. A MADC (Missing Allele Discovery Counts) table records the read count of every
microhaplotype in every sample. A microhaplotype is the short sequence a marker amplifies, so a
marker can have more than two alleles, and the variants beside its target SNP are kept. `madcats`
counts the alleles a panel was designed for and finds additional ones in the reads.
Comment thread README.md
Comment on lines +135 to +136
writes the MADC table, a QC JSON with the parameters and per-sample read accounting, and a table
of each row's variants. See
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.

2 participants