Summary statistics for assembled contigs in FASTA format. For raw reads, see Genomic Read Summary.
Example
Section titled “Example”import pysegul
def summarize_contigs(): summary = pysegul.ContigSummary( input_fmt='auto', output_dir='tests/output', output_prefix='contig_summary', ) outputs = summary.from_dir('tests/contig-data')To use a list of files, call from_files instead of from_dir:
summary.from_files(['tests/contig-data/contig1.fasta', 'tests/contig-data/contig2.fasta'])Options
Section titled “Options”| Option | Default | Description |
|---|---|---|
input_fmt | Required | 'auto', 'fasta', 'gzip' |
output_dir | Required | Output directory |
output_prefix | None | Name of the output files |
plot (beta) | None | Chart options. See Charts |
Methods
Section titled “Methods”| Method | Description |
|---|---|
from_dir(input_dir) | Summarize the contig files in a directory |
from_files(input_files) | Summarize a list of contig files |
Both return a dictionary of output paths: summary, report, and plots.
Charts
Section titled “Charts”Set plot to write charts to the plots folder of the output directory. See Charts and Reports for the chart options.
summary = pysegul.ContigSummary( 'auto', 'tests/output', plot=pysegul.PlotOptions(format='svg'), )outputs = summary.from_dir('tests/contig-data')report = pysegul.load_contig_report(outputs['report'])