Repository navigation
README edits - #4
Merged
Merged
Conversation
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.
There was a problem hiding this comment.
🟡 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
callandfilter-paralogsas experimental.
| File | Description |
|---|---|
README.md |
Streamlines introductory guidance, clarifies downstream workflows, and adds experimental labels. |
Review effort: Balanced
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 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 |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.

Summary
A shorter README, 1,161 words against 1,309. Only
README.mdchanges.pipxand a clone. Quick Start keeps the main route and links the tutorials for the others. Input Formats and Output become one paragraph with links.madcats callstraight from the raw table.callandfilter-paralogsare marked experimental in the introduction, Highlights and the Commands table.