Skip to content

Genomic Contig Summary

Summary statistics for assembled contigs in FASTA format. For raw reads, see Genomic Read Summary.

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'])
OptionDefaultDescription
input_fmtRequired'auto', 'fasta', 'gzip'
output_dirRequiredOutput directory
output_prefixNoneName of the output files
plot (beta)NoneChart options. See Charts
MethodDescription
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.

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'])

This material is based upon work supported by the National Science Foundation under grant numbers: DEB-1754393 and DEB-2244754. Any opinions, findings, and conclusions or recommendations expressed in this material are those of the authors and do not necessarily reflect the views of the National Science Foundation.