Documentation

ParseTransfacMatrixManager extends ParseTransfacAbstractManager

FinalYes

Class ParseTransfacMatrixManager A matrix record holds the nucleotide weight matrix describing what a transcription factor binds : one row per position of the binding site, counting how often each of A, C, G and T was observed there.

Tags
author

Amélie DUVERNET aka Amelaye amelieonline@gmail.com

Table of Contents

Properties

$accession  : string
$dateCreated  : string
$dateUpdated  : string
$id  : string
$basis  : string
$comments  : string
$description  : string
$matrix  : array<string|int, mixed>
One row per position : ["A" => 1, "C" => 2, "G" => 2, "T" => 0, "consensus" => "N"].
$name  : string

Methods

__construct()  : mixed
Constructor.
getAccession()  : string
getBasis()  : string
getComments()  : string
getDateCreated()  : string
getDateUpdated()  : string
getDescription()  : string
getEntryId()  : string
Extracts the identifier uniquely naming a TRANSFAC record, its accession number.
getFormat()  : string
The name this format is known by in the collection records and in DatabaseParserFactory.
getId()  : string
getMatrix()  : array<string|int, mixed>
getName()  : string
isEntryEnd()  : bool
Tells whether a line closes a TRANSFAC record.
isEntryStart()  : bool
Tells whether a line opens a new TRANSFAC record, which the accession number does.
parseDataFile()  : Sequence
Parses a TRANSFAC matrix data file and populates this manager's fields.
append()  : string
Appends the data of a line to a field written over several of them.
parseCommonField()  : bool
Reads the fields every TRANSFAC record carries, and says whether it did : a subclass calls this first and only looks at the labels of its own record when it did not.
parseDate()  : mixed
Parses one DT line, which dates either the creation or the last update of the record and may carry a time of day.
readData()  : string
Reads the data a line carries, which starts at its fifth column.
readLabel()  : string
Reads the two-letter label a line carries.
splitList()  : array<string|int, mixed>
Splits a field listing its values, semicolon separated and possibly closed by a period, into its items.
parseMatrixRow()  : array<string|int, mixed>
Parses one row of the weight matrix, the label being the position it describes.

Properties

$matrix

One row per position : ["A" => 1, "C" => 2, "G" => 2, "T" => 0, "consensus" => "N"].

private array<string|int, mixed> $matrix = []

Methods

getEntryId()

Extracts the identifier uniquely naming a TRANSFAC record, its accession number.

public static getEntryId(array<string|int, mixed> $aFlines, string $sLine) : string
Parameters
$aFlines : array<string|int, mixed>

The whole file, buffered

$sLine : string

The line opening the entry

Return values
string

getFormat()

The name this format is known by in the collection records and in DatabaseParserFactory.

public static getFormat() : string
Return values
string

isEntryEnd()

Tells whether a line closes a TRANSFAC record.

public static isEntryEnd(string $sLine) : bool
Parameters
$sLine : string

The line to analyze

Return values
bool

isEntryStart()

Tells whether a line opens a new TRANSFAC record, which the accession number does.

public static isEntryStart(string $sLine) : bool
Parameters
$sLine : string

The line to analyze

Return values
bool

parseDataFile()

Parses a TRANSFAC matrix data file and populates this manager's fields.

public parseDataFile(array<string|int, mixed> $aFlines) : Sequence
Parameters
$aFlines : array<string|int, mixed>

The lines the script has to parse

Tags
throws
Exception
Return values
Sequence

$oSequence

append()

Appends the data of a line to a field written over several of them.

protected append(string $sBuffer, string $sData) : string
Parameters
$sBuffer : string
$sData : string
Return values
string

parseCommonField()

Reads the fields every TRANSFAC record carries, and says whether it did : a subclass calls this first and only looks at the labels of its own record when it did not.

protected parseCommonField(string $sLabel, string $sData) : bool
Parameters
$sLabel : string
$sData : string
Return values
bool

parseDate()

Parses one DT line, which dates either the creation or the last update of the record and may carry a time of day.

protected parseDate(string $sData) : mixed

Format : DT 20.06.90 11:00:03 (created); ewi.

Parameters
$sData : string

readData()

Reads the data a line carries, which starts at its fifth column.

protected static readData(string $sLine) : string
Parameters
$sLine : string

The line to analyze

Return values
string

readLabel()

Reads the two-letter label a line carries.

protected static readLabel(string $sLine) : string
Parameters
$sLine : string

The line to analyze

Return values
string

splitList()

Splits a field listing its values, semicolon separated and possibly closed by a period, into its items.

protected splitList(string $sText[, string $sSeparator = ";" ]) : array<string|int, mixed>
Parameters
$sText : string
$sSeparator : string = ";"
Return values
array<string|int, mixed>

parseMatrixRow()

Parses one row of the weight matrix, the label being the position it describes.

private parseMatrixRow(string $sData) : array<string|int, mixed>

Format : 01 1 2 2 0 N

Parameters
$sData : string
Return values
array<string|int, mixed>
On this page

Search results