get

Retrieve property of object

Syntax

S = get(object)

propertyValues = get(object,propertyNames)

Description

S = get(object) returns a structure containing a field for each property of a BioRead or BioMap object.

propertyValues = get(object,propertyNames) returns the values of the properties specified by propertyNames.

Examples

Retrieve Sequencing Data from BioRead

Store read data from a SAM-formatted file in a BioRead object.

br = BioRead('ex1.sam')

br = 
  BioRead with properties:

     Quality: [1501x1 File indexed property]
    Sequence: [1501x1 File indexed property]
      Header: [1501x1 File indexed property]
       NSeqs: 1501
        Name: ''

Retrieve the data from the object. data is a structure containing a field for each object property, such as Quality, Sequence, Header, NSeqs, and Name.

data = get(br)

data = struct with fields:
     Quality: {1501x1 cell}
    Sequence: {1501x1 cell}
      Header: {1501x1 cell}
       NSeqs: 1501
        Name: ''

Retrieve the header data only.

headers = get(br,'Header');

You can also retrieve a subset of properties.

subset = get(br,{'Header','NSeqs'});

Input Arguments

object — Object containing read data

BioRead object | BioMap object

Object containing the read data, specified as a BioRead or BioMap object.

Example: bioreadObj

propertyNames — Names of object properties

character vector | string | string vector | cell array of character vectors

Names of the object properties, specified as a character vector, string, string vector, or cell array of character vectors.

Example: {'Quality','Sequence'}

Output Arguments

S — Object property data

structure

Object property data, returned as a structure containing a field for each property of the object.

propertyValues — Property values

cell array

Property values, returned as a cell array.