BP_BIOFLAT_INDEX(1p)

πŸ“¦
version 1.7.8 Β· 3 versions
, in debian bookworm, debian trixie, ubuntu jammy, ubuntu noble

πŸ‘‘ NAME πŸ‘‘

bp_bioflat_index.pl β€” bestie, this is the lil script that indexes your sequence files using Bio::DB::Flat. πŸ’…


✨ DESCRIPTION ✨

okay so picture this: you've got a pile of flat files full of sequence info, and you want them in a proper biological sequence database that's indexed with the Bio::DB::Flat indexing scheme. That's literally the whole job. 🌸

You can create a fresh one or update one that already exists β€” your call. And the arguments? Just a list of flat files holding the sequence information you want indexed. Hand them over, one after another. Easy. 🫢


πŸŽ€ USAGE πŸŽ€

bp_bioflat_index.pl <options> file1 file2 file3...

Options:

  • --create β€” create the index from scratch, or reinitialize it. ✨ If you don't pass this, the index has to already exist β€” no cap, it will not conjure one out of thin air.
  • --format <format> β€” the format of your sequence files. It must be one of "genbank", "swissprot", "embl" or "fasta". That's the whole menu, bestie. πŸ“
  • --location <path> β€” the path to the directory where the index files live. πŸŽ€
  • --dbname <name> β€” the symbolic name of the database you're creating. πŸ’–
  • --indextype <type> β€” the type of index to create. Either "bdb" or "flat". And heads up: "binarysearch" is the same thing as "flat". πŸ”₯
Fun fact: options can be abbreviated! So like, -i totally works for --indextype. Iconic behavior honestly.

And if you don't bother providing some of these options, these environment variables step in as the defaults, like the supportive besties they are: 🌈

  • OBDA_FORMAT β€” format of sequence file
  • OBDA_LOCATION β€” path to directory in which index files are stored
  • OBDA_DBNAME β€” name of database
  • OBDA_INDEX β€” type of index to create

okay that's the whole page, mwah πŸ’‹ β€” this was BP_BIOFLAT_INDEX(1p), part of the User Contributed Perl Documentation, running on perl v5.32.1, dated 2021-08-15. go index something gorgeous, bestie πŸ‘‘βœ¨

πŸ“¦ where this page comes from