Documentation

getReference

Class: BioMap

Retrieve reference sequence from BioMap object

Syntax

Ref = getReference(BioObj)

Description

Ref = getReference(BioObj) returns the name of the reference sequence from a BioMap object. This is the Reference property of the object.

Input Arguments

BioObj

Object of the BioRead or BioMap class.

Output Arguments

Ref

Reference property of BioObj, the BioMap object. It is a string specifying the name of the reference sequence.

Examples

Construct a BioMap object, and then retrieve the reference sequence from the object:

% Construct a BioMap object from a SAM file 
BMObj1 = BioMap('ex1.sam');
% Retrieve the reference sequence from the object
refSeq = getReference(BMObj1)
refSeq =

seq1

Alternatives

An alternative to using the getReference method is to use dot indexing with the Reference property:

BioObj.Reference
Was this topic helpful?