Keywords: manual

Next: sequence_db.write() write Up: The sequence_db class: using Previous: sequence_db() create Contents Index

## sequence_db.read() -- read a database of sequences

`read(chains_list, seq_database_file, seq_database_format, clean_sequences=True, minmax_db_seq_len=(0, 999999))`

> This command will read a database of sequences, either in the `PIR`, `FASTA`, or `BINARY` format.

> If the format is `PIR` or `FASTA`:

- It is possible to clean all sequences of non-standard residue types by setting clean_sequences to `True`.

- Sequences shorter than minmax_db_seq_len[0] and longer than minmax_db_seq_len[1] are eliminated.

- Only sequences whose codes are listed in the chains_list file are read from the seq_database_file of sequences. If chains_list is `all`, all sequences in the seq_database_file file are read in, and there is no need for the chains_list file.

> For the `PIR` and `FASTA` formats, make sure the order of sequences in the chains_list and seq_database_file is the same for faster access (there can of course be more sequences in the sequence file than there are sequence codes in the codes file).

> Additionally, if the sequences are in 'PIR' format, then the protein type and resolution fields are stored in the database format. (see Section B.1 for description of 'PIR' fields).

> The protein type field is encoded in a single letter format. 'S' for sequence and 'X' for structures of any kind. This information is transferred to the profile arrays when using profile.build(). (See also profile.read()).

> The resolution field is used to pick representatives from the clusters in sequence_db.filter().

> None of the options above apply to the `BINARY` format, which, in return, is very fast (i.e., 3 seconds for 300 MB of 800,000 sequences in the TrEMBL database). Binary files are standard HDF5 files (see Section B.4).

> Note that the entire sequence database is stored in memory. Thus, extremely large databases, such as UNIPROT, will require your computer to have a large amount of system memory (RAM) available, to store the database and to provide working space. In cases where the database requires more than 2 gigabytes of memory, you will also need to use a 64-bit machine, such as Alpha, Itanium, or x86_64 (Opteron/EM64T).

> If you are intending to read in a sequence database simply to write it out again in binary format, you should consider using the sequence_db.convert() function instead, as this does not need to keep the whole database in memory.

Example: See profile.build() command.

Next: sequence_db.write() write Up: The sequence_db class: using Previous: sequence_db() create Contents Index