gunshotmatch_reports.alignment
CSV reports of alignment between reference projects and unknown samples.
New in version 0.5.0.
Classes:
|
Represents data for a peak in a CSV report. |
Functions:
|
Returns CSV report for the alignment between the given projects. |
|
Returns CSV report for the alignment between the given projects and unknown. |
|
Return data for the CSV report for given peak in the given project. |
-
namedtuple
CSVRow
(peak_no='', name='', rt='', area='', area_percentage='', match_factor='')[source] Bases:
NamedTuple
Represents data for a peak in a CSV report.
- Fields
-
__repr__
() Return a nicely formatted representation string
-
csv_two_projects
(p1, padded_p1_cp, p2, padded_p2_cp)[source] Returns CSV report for the alignment between the given projects.
- Parameters
p1 (
Project
) – The first project.padded_p1_cp (
MutableSequence
[Optional
[ConsolidatedPeak
]]) – Padded consolidated peak list for the first project.p2 (
Project
) – The second project.padded_p2_cp (
MutableSequence
[Optional
[ConsolidatedPeak
]]) – Padded consolidated peak list for the second project.
- Return type
-
csv_two_projects_and_unknown
(p1, padded_p1_cp, p2, padded_p2_cp, u, padded_u_cp, *, pair_only=False)[source] Returns CSV report for the alignment between the given projects and unknown.
- Parameters
p1 (
Project
) – The first project.padded_p1_cp (
MutableSequence
[Optional
[ConsolidatedPeak
]]) – Padded consolidated peak list for the first project.p2 (
Project
) – The second project.padded_p2_cp (
MutableSequence
[Optional
[ConsolidatedPeak
]]) – Padded consolidated peak list for the second project.u (
Project
) – The unknown sample.padded_u_cp (
MutableSequence
[Optional
[ConsolidatedPeak
]]) – Padded consolidated peak list for the unknown sample.pair_only (
bool
) – Only show peaks in common between two or more of the projects/unknown. DefaultFalse
.
- Return type