filterByFlag

Класс: BioMap

Последовательность фильтров считывается флагом SAM

Синтаксис

Indices = filterByFlag(BioObj, FlagName, FlagValue)
Indices = filterByFlag(BioObj, Subset, FlagName, FlagValue)
Indices = filterByFlag(..., FlagName1, FlagValue1, FlagName2, FlagValue2, ...)

Описание

Indices = filterByFlag(BioObj, FlagName, FlagValue) возвращает Indicesвектор логических индексов, указывающий на считанные последовательности в BioObj, а BioMap объект, с FlagName установлено на FlagValue.

Indices = filterByFlag(BioObj, Subset, FlagName, FlagValue) возвращает Indicesвектор логических индексов, указывающий последовательности чтения, которые удовлетворяют заданным критериям из подмножества записей в BioMap объект.

Indices = filterByFlag(..., FlagName1, FlagValue1, FlagName2, FlagValue2, ...) применяет несколько фильтров флагов в одном операторе.

Входные параметры

BioObj

Объект BioMap класс.

Subset

Любое из следующих для задания подмножества элементов в BioObj:

  • Вектор положительных целых чисел

  • Логический вектор

FlagName

Вектор символов или строка, задающая один из следующих флагов для фильтрации:

  • 'pairedInSeq' - Чтение спарено в секвенировании, независимо от того, отображено ли оно как пара.

  • 'pairedInMap' - Чтение отображается в правильной паре.

  • 'unmappedQuery' - Чтение не сопоставлено.

  • 'unmappedMate' - Мат не сопоставлен.

  • 'strandQuery' - Направление нити чтения (0 = вперед, 1 = реверс).

  • 'strandMate' - Направление пряди сопряжения (0 = вперед, 1 = реверс).

  • 'readIsFirst' - Чтение сначала в паре.

  • 'readIsSecond' - Чтение является вторым в паре.

  • 'alnNotPrimary' - Выравнивание чтения не является основным.

  • 'failedQualCheck' - Чтение не проверяет качество платформы или поставщика.

  • 'duplicate' - Чтение является PCR или оптическим дубликатом.

FlagValue

Логическое значение, указывающее на состояние флага. A 0 указывает false или вперед, и 1 указывает true или наоборот.

Выходные аргументы

Indices

Вектор логических индексов, указывающий последовательности чтения в BioObj с FlagName установлено на FlagValue.

Примеры

Создайте a BioMap объект, а затем определите последовательности чтения, которые оба отображены в правильной паре и сначала в паре:

% Construct a BioMap object from a SAM file 
BMObj1 = BioMap('ex1.sam');
% Filter the elements using 'pairedInMap' and 'readIsFirst' flags 
Indices = filterByFlag(BMObj1, 'pairedInMap', true,...
                       'readIsFirst', true);
% Return the headers of the filtered elements
filtered_Headers = BMObj1.Header(Indices);