cobs_index.compact_construct

compact_construct(input: str, out_file: str, index_params: cobs_index.CompactIndexParameters = <cobs_index.CompactIndexParameters object at 0x7f49d2030618>, file_type: str = 'any', tmp_path: str = '') → None

Construct a COBS Compact Index from a path of input files.

Parameters

  • input (str) – path to the input directory or file

  • out_file (str) – path to the output .cobs_compact index file

  • index_params (CompactIndexParameters) – instance of compact index parameter object

  • file_type (str) – filter input documents by file type (any, text, cortex, fasta, etc), default: any

  • tmp_path (str) – directory for intermediate index files, default: out_file + .tmp