Skip to content
BranchesTags

Repository files navigation

pgr - Practical Genome Refiner

Buildcodecovlicense

pgr is a command-line toolkit for working with genomes and genome-derived data: sequences, alignments, variation, and related formats.

It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a focus on:

  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF, GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)

High-level capabilities include:

  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure generation

Install

Current release: 0.5.0

cargo install --path . --force #--offline# test
cargo test -- --test-threads=1

Usage

After installation, the pgr binary should be available in your PATH:

pgr help
pgr fa --help
pgr fas --help

Command naming conventions

pgr organizes commands in two levels. The naming rules make the command line predictable:

First-level commands are named after the input format or the task domain:

  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain, net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot, align, pgi, pbit

Second-level commands follow one of three naming patterns:

  1. Operations within one format (the majority, 70+ commands): fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap, paf query/graph, sd align/cluster/cross, runlist span/compare/merge. Because the input and output share the same format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to- prefix (about 25 commands across 12 families): to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed, to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx, to-rg. This is the project-wide rule that answers "input or output": conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument: gff rg, gff runlist (output format, without the to- prefix), chain net, psl chain (output format), fa masked, 2bit masked (output property), fa range, 2bit range, pbit range, runlist genome (input argument concept), paf graph/index (artifact), plot dot/hh/nrps/venn (output chart type).

Rule of thumb: a second-level command is named by its operation when the format does not change, by the output (to-X) when it crosses formats, and by the artifact or argument when neither applies.

Examples

This repository contains many subcommands and end-to-end workflows. Extended and curated examples are collected in:

  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)

Below are a few quick examples to get started:

# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa

External dependencies

Some subcommands depend on external executables:

  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit, axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic, netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter, netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as clustalw (default), muscle, or mafft.

Author

Qiang Wang wang-q@outlook.com

License

MIT.

Copyright by Qiang Wang.

Written by Qiang Wang wang-q@outlook.com, 2024-

About

pgr - Practical Genome Refiner

Resources

Readme
MIT license
Activity

Stars

1 star

Watchers

2 watching

Forks

0 forks
Report repository

Releases

Packages

Used by

Contributors

Languages

, 'i'); if (__m === '*' || __re.test(location.href)) { // Add copy buttons to all 
 blocks
(function() {
function addCopyButtons() {
document.querySelectorAll('pre code').forEach(function(codeBlock) {
if (codeBlock.parentElement.hasAttribute('data-copy-added')) return;
codeBlock.parentElement.setAttribute('data-copy-added', 'true');
var btn = document.createElement('button');
btn.textContent = 'Copy';
btn.style.cssText = 'position:absolute;top:4px;right:4px;padding:2px 8px;font-size:11px;background:#4ecdc4;border:none;border-radius:4px;color:#1a1a2e;cursor:pointer;opacity:0.7;transition:opacity 0.2s;';
btn.onmouseover = function() { this.style.opacity = '1'; };
btn.onmouseout = function() { this.style.opacity = '0.7'; };
btn.onclick = function() {
navigator.clipboard.writeText(codeBlock.textContent).then(function() {
btn.textContent = 'Copied!';
setTimeout(function() { btn.textContent = 'Copy'; }, 1500);
});
};
codeBlock.parentElement.style.position = 'relative';
codeBlock.parentElement.appendChild(btn);
});
}
addCopyButtons();
// Re-run on dynamic content
var observer = new MutationObserver(addCopyButtons);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Add Copy Buttons to Code Blocks]', __e); }
})();
(function(){
try {
var __m = "github.com";
var __re = new RegExp('^' + "github\\.com" + '
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Force GitHub README to respect dark mode
(function() {
var style = document.createElement('style');
style.textContent = '
.markdown-body {
color-scheme: dark light;
}
.markdown-body pre { background: #161b22 !important; }
.markdown-body code { background: rgba(110, 118, 129, 0.4) !important; }
.markdown-body table th, .markdown-body table td { border-color: #30363d !important; }
.markdown-body img { background: #0d1117; }
.markdown-body blockquote { border-left-color: #8b949e; }
.markdown-body hr { border-color: #30363d; }
';
document.head.appendChild(style);
})();
}
} catch(__e) { console.warn('[Userscript:GitHub Dark Mode README Fix]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Highlight search terms from Google/DuckDuckGo/Bing referrer
(function() {
var ref = document.referrer;
var terms = [];
if (ref.includes('google.com') || ref.includes('duckduckgo.com') || ref.includes('bing.com')) {
var url = new URL(ref);
var q = url.searchParams.get('q') || url.searchParams.get('p');
if (q) {
terms = q.split(/\s+/).filter(function(t) { return t.length > 2; });
}
}
if (terms.length === 0) return;
var style = document.createElement('style');
style.textContent = '.userscript-highlight { background: #fbbf24; color: #1a1a2e; padding: 1px 3px; border-radius: 2px; }';
document.head.appendChild(style);
function highlight(node) {
if (node.nodeType === 3) { // text node
var text = node.textContent;
var found = false;
terms.forEach(function(term) {
var regex = new RegExp('(' + term.replace(/[.*+?^${}()|[\]\\]/g, '\\') + ')', 'gi');
if (regex.test(text)) {
found = true;
var frag = document.createDocumentFragment();
var parts = text.split(regex);
parts.forEach(function(part, i) {
if (i % 2 === 0) {
frag.appendChild(document.createTextNode(part));
} else {
var span = document.createElement('span');
span.className = 'userscript-highlight';
span.textContent = part;
frag.appendChild(span);
}
});
node.parentNode.replaceChild(frag, node);
}
});
} else if (node.nodeType === 1 && node.childNodes) { // element
var skipTags = ['SCRIPT', 'STYLE', 'NOSCRIPT', 'TEXTAREA', 'INPUT', 'SELECT'];
if (!skipTags.includes(node.tagName)) {
Array.from(node.childNodes).forEach(highlight);
}
}
}
highlight(document.body);
// Re-highlight on dynamic content
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1 || node.nodeType === 3) highlight(node);
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Highlight Search Terms]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Strip utm_, fbclid, gclid, etc. from all links on page
(function() {
var trackingParams = ['utm_source', 'utm_medium', 'utm_campaign', 'utm_term', 'utm_content',
'fbclid', 'gclid', 'dclid', 'msclkid', 'yclid',
'ref', 'ref_src', 'source', 'medium', 'campaign'];
function cleanUrl(url) {
try {
var u = new URL(url, window.location.origin);
var changed = false;
trackingParams.forEach(function(p) {
if (u.searchParams.has(p)) {
u.searchParams.delete(p);
changed = true;
}
});
return changed ? u.toString() : url;
} catch (e) {
return url;
}
}
function cleanLinks() {
document.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
cleanLinks();
var observer = new MutationObserver(function(mutations) {
mutations.forEach(function(m) {
m.addedNodes.forEach(function(node) {
if (node.nodeType === 1) {
if (node.tagName === 'A') cleanLinks();
node.querySelectorAll('a[href]').forEach(function(a) {
var clean = cleanUrl(a.href);
if (clean !== a.href) a.href = clean;
});
}
});
});
});
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:Remove Tracking Parameters from Links]', __e); }
})();
(function(){
try {
var __m = "youtube.com";
var __re = new RegExp('^' + "youtube\\.com" + '
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Auto-enable theater mode on YouTube
(function() {
function tryTheater() {
var btn = document.querySelector('button[aria-label="Theater mode"], ytd-player #player button[title="Theater mode"]');
if (btn && !btn.classList.contains('activated')) {
btn.click();
}
}
// Try immediately
tryTheater();
// Try after navigation (SPA)
var lastUrl = location.href;
setInterval(function() {
if (location.href !== lastUrl) {
lastUrl = location.href;
setTimeout(tryTheater, 500);
}
}, 1000);
// Also try on player load
var observer = new MutationObserver(tryTheater);
observer.observe(document.body, { childList: true, subtree: true });
})();
}
} catch(__e) { console.warn('[Userscript:YouTube Theater Mode Default]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Remove or un-stick sticky/fixed headers that block content
(function() {
function unstick() {
document.querySelectorAll('header, nav, [role="banner"], .header, .navbar, .sticky, .fixed-top, [style*="position: fixed"], [style*="position:sticky"]').forEach(function(el) {
if (el.style.position === 'fixed' || el.style.position === 'sticky' || getComputedStyle(el).position === 'fixed' || getComputedStyle(el).position === 'sticky') {
el.style.position = 'static';
el.style.top = 'auto';
el.style.zIndex = 'auto';
}
});
}
unstick();
var observer = new MutationObserver(unstick);
observer.observe(document.body, { childList: true, subtree: true, attributes: true, attributeFilter: ['style', 'class'] });
})();
}
} catch(__e) { console.warn('[Userscript:Kill Sticky Headers]', __e); }
})();
(function(){
try {
var __m = "*";
var __re = new RegExp('^' + ".*" + '
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages

, 'i');
if (__m === '*' || __re.test(location.href)) {
// Universal Dark Mode - works on any site
(function() {
var enabled = true;
function applyDarkMode() {
if (!enabled) return;
// Create style element if it doesn't exist
var style = document.getElementById('universal-dark-mode-style');
if (!style) {
style = document.createElement('style');
style.id = 'universal-dark-mode-style';
document.head.appendChild(style);
}
// Dark mode CSS - inverts colors but preserves images/video
style.textContent = '
/* Invert everything except media */
html {
filter: invert(1) hue-rotate(180deg) !important;
background: #1a1a2e !important;
}
/* Restore images, videos, iframes, canvas */
img, video, iframe, canvas, svg, picture, [style*="background-image"] {
filter: invert(1) hue-rotate(180deg) !important;
}
/* Preserve specific elements that should not be inverted */
.no-dark-mode, .no-dark-mode *,
[data-theme="light"], [data-theme="light"],
.ace_editor, .ace_editor *,
.CodeMirror, .CodeMirror *,
.monaco-editor, .monaco-editor *,
.markdown-body pre, .markdown-body pre *,
.highlight, .highlight *,
pre code, pre code * {
filter: none !important;
}
/* Fix common UI elements */
.modal, .popup, .dropdown-menu, .tooltip, .popover {
filter: invert(1) hue-rotate(180deg) !important;
background: #2d2d44 !important;
border-color: #444 !important;
}
/* Scrollbars */
::-webkit-scrollbar { background: #1a1a2e !important; }
::-webkit-scrollbar-thumb { background: #444 !important; }
::-webkit-scrollbar-thumb:hover { background: #555 !important; }
/* Selection */
::selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
::-moz-selection { background: #4ecdc4 !important; color: #1a1a2e !important; }
';
}
function removeDarkMode() {
var style = document.getElementById('universal-dark-mode-style');
if (style) style.remove();
}
// Toggle with Alt+Shift+D
document.addEventListener('keydown', function(e) {
if (e.altKey && e.shiftKey && e.key === 'D') {
e.preventDefault();
enabled = !enabled;
if (enabled) {
applyDarkMode();
console.log('[Universal Dark Mode] Enabled');
} else {
removeDarkMode();
console.log('[Universal Dark Mode] Disabled');
}
}
});
// Apply on load
applyDarkMode();
// Re-apply on dynamic content
var observer = new MutationObserver(function(mutations) {
if (enabled && !document.getElementById('universal-dark-mode-style')) {
applyDarkMode();
}
});
observer.observe(document.head, { childList: true });
console.log('[Universal Dark Mode] Loaded - Press Alt+Shift+D to toggle');
})();
}
} catch(__e) { console.warn('[Userscript:Universal Dark Mode]', __e); }
})();
})();
GitHub - wang-q/pgr: pgr - Practical Genome Refiner · GitHub
Skip to content
BranchesTags
Repository files navigation
pgr - Practical Genome Refiner
Buildcodecovlicense
pgr is a command-line toolkit for working with genomes and genome-derived data: sequences,
alignments, variation, and related formats.
It is designed as a practical “Swiss Army knife” for day-to-day bioinformatics workflows, with a
focus on:
  • Format-aware utilities for common genomics file types (FASTA/FASTQ/2bit, AXT/PSL/Chain/Net/MAF,
GFF)
  • Interoperable outputs (tabular conventions, FASTA/MAF for alignments)
  • Pipeline-friendly behavior (stdin/stdout where possible, predictable output, composable
subcommands)
  • Performance and robustness (Rust implementation, zero-panic policy for malformed inputs)
High-level capabilities include:
  • Sequences: FASTA/FASTQ inspection, filtering, slicing, conversion, 2bit querying, and pbit
population archive compression
  • Alignments: sorting, filtering, conversion, and coordinate/range utilities across UCSC formats
  • Pangenome: PAF implicit graph indexing, querying, and conversion (BED/MAF/GFA/VCF)
  • Pipelines & plots: integrated workflows (optionally using external tools) and LaTeX/TikZ figure
generation
Install
Current release: 0.5.0
cargo install --path . --force #--offline# test
cargo test -- --test-threads=1
Usage
After installation, the pgr binary should be available in your PATH:
pgr help
pgr fa --help
pgr fas --help
Command naming conventions
pgr organizes commands in two levels. The naming rules make the command line
predictable:
First-level commands are named after the input format or the task domain:
  • Input formats: fa, fas, fq, 2bit, gff, rg, axt, chain,
net, maf, paf, psl, lav, ms
  • Task domains: dist, sd, rept, kmer, runlist, pl, plot,
align, pgi, pbit
Second-level commands follow one of three naming patterns:
  1. Operations within one format (the majority, 70+ commands):
fa mask/sort/dedup/filter/rc/size, psl lift/stats/swap,
paf query/graph, sd align/cluster/cross,
runlist span/compare/merge. Because the input and output share the same
format, the operation name is what distinguishes one command from another.
  2. Format conversions are named after the output, with a uniform to-
prefix (about 25 commands across 12 families):
to-psl, to-maf, to-fas, to-paf, to-vcf, to-gfa, to-bed,
to-chain, to-axt, to-hv, to-fa, to-2bit, to-dna, to-xlsx,
to-rg. This is the project-wide rule that answers "input or output":
conversion commands are named after the output format.
  3. A few commands are named after the artifact or the argument:
gff rg, gff runlist (output format, without the to- prefix),
chain net, psl chain (output format), fa masked, 2bit masked
(output property), fa range, 2bit range, pbit range,
runlist genome (input argument concept), paf graph/index (artifact),
plot dot/hh/nrps/venn (output chart type).
Rule of thumb: a second-level command is named by its operation when the
format does not change, by the output (to-X) when it crosses formats, and
by the artifact or argument when neither applies.
Examples
This repository contains many subcommands and end-to-end workflows. Extended and curated examples
are collected in:
  • docs/usage_examples.md
  • docs/rept.md (repeat masking: libraries, RepeatMasker, pgr rept e-kmer/s-kmer/trf)
Below are a few quick examples to get started:
# Basic FASTA statistics
pgr fa size tests/fasta/ufasta.fa
# Block FA summary
pgr fas stat tests/fas/example.fas --outgroup
# 2bit range extraction
pgr 2bit range tests/genome/mg1655.2bit NC_000913:1-100
# Create a pbit population archive from a reference and sample assemblies
pgr pbit create -r tests/pgr/pseudocat.fa -i tests/pgr/pseudopig.fa -o tmp.pbit
# Extract a region from all samples in the archive
pgr pbit range tmp.pbit scaffold_1:1-1000 -o tmp.fa
External dependencies
Some subcommands depend on external executables:
  • pgr pl ucsc requires the UCSC kent-tools suite, including programs such as faToTwoBit,
axtChain, chainAntiRepeat, chainMergeSort, chainPreNet,chainNet, netSyntenic,
netChainSubset, chainStitchId, netSplit,netToAxt, axtSort, axtToMaf, netFilter,
netClass, and chainSplit.
  • pgr rept trf depends on trf.
  • pgr fas refine depends on an external multiple sequence alignment tool such as
clustalw (default), muscle, or mafft.
Author
Qiang Wang wang-q@outlook.com
License
MIT.
Copyright by Qiang Wang.
Written by Qiang Wang wang-q@outlook.com, 2024-
About
pgr - Practical Genome Refiner
Resources
Readme
MIT license
Activity
Stars
1 star
Watchers
2 watching
Forks
0 forks
Report repository
Releases
Packages
Used by
Contributors
Languages