list_index {bioseq.fasta} R Documentation

make sequence list index

Description

Usage

list_index(x,
    ids = NULL);

Arguments

x

a fasta sequence collection for make the sequence index, which can be a FastaFile object, a collection of the FastaSeq object, or a character vector of the raw sequence data.

ids

a character vector of the index key of each sequence, the length of this vector should be equals to the size of the input sequence collection. If this parameter is not specified, then the first token of the fasta headers title text of each sequence will be used as the index key.

env

the R# runtime environment object. [as Environment]

Details

the index key of the generated list object is unique: the duplicated key will be renamed automatically by appending an unique numeric suffix.

Authors

seqtoolkit

Value

a named list of the FastaSeq sequence object, the name of the list element is the corresponding index key of the sequence, so that we can get the target sequence object by the index key directly.

this function returns a R# error message object if the input sequence data can not be cast to a fasta sequence collection.

clr value class

Examples

[Package bioseq.fasta version 1.0.0.0 Index]