load_annotations#

load_annotations(*, path: str | PathLike | PurePath | Path, seqids: str | None = None, db: SupportsFeatures | None = None, write_path: str | PathLike | PurePath | Path = ':memory:', lines_per_block: int | None = 500000, show_progress: bool = False) SupportsFeatures#

loads annotations from flatfile into a db

Parameters:
path

path to a plain text file containing features

seqids

only features whose seqid matches a provided identifier are returned, the default is all features.

db

an existing feature db to add these records to. Must be of a compatible type.

write_path

where the constructed database should be written, defaults to memory only

lines_per_block

number of lines to insert into the db per iteration. This can help with memory usage. Only applies to gff files.

show_progress

applied only if loading features from multiple files

Notes

We DO NOT check if a provided db already contains records from a flatfile.