/usr/include/d/bio/sam/header.d is in libbiod-dev 0.1.0-5build1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 610 611 612 613 614 615 616 617 618 619 620 621 622 623 624 625 626 627 628 629 630 631 632 633 634 635 636 637 638 639 640 641 642 643 644 645 646 647 648 649 650 651 652 653 654 655 656 657 658 659 660 661 662 663 664 665 666 667 668 669 670 671 672 673 674 675 676 677 678 679 680 681 682 683 684 685 686 687 688 689 690 691 692 693 694 695 696 697 698 699 700 701 702 703 704 705 706 707 708 709 710 711 712 713 714 715 716 717 718 719 720 721 722 723 724 725 726 727 728 729 730 731 732 733 734 735 736 737 738 739 740 741 742 743 744 745 746 747 748 749 750 751 752 753 754 755 756 757 758 759 760 761 762 763 764 765 766 767 768 769 770 771 772 773 774 775 776 777 778 779 780 781 782 783 784 785 786 787 788 789 790 791 792 793 794 795 796 797 798 799 800 801 802 803 804 | /*
This file is part of BioD.
Copyright (C) 2012-2016 Artem Tarasov <lomereiter@gmail.com>
Permission is hereby granted, free of charge, to any person obtaining a
copy of this software and associated documentation files (the "Software"),
to deal in the Software without restriction, including without limitation
the rights to use, copy, modify, merge, publish, distribute, sublicense,
and/or sell copies of the Software, and to permit persons to whom the
Software is furnished to do so, subject to the following conditions:
The above copyright notice and this permission notice shall be included in
all copies or substantial portions of the Software.
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING
FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER
DEALINGS IN THE SOFTWARE.
*/
module bio.sam.header;
import bio.bam.thirdparty.msgpack;
import bio.core.utils.format;
import std.algorithm;
import std.conv;
import std.format;
import std.json;
import std.exception;
import std.array;
import std.range;
import std.traits;
import std.stdio : stderr;
private {
struct Field(string _name, string _abbr, T = string) {
enum name = _name;
enum abbr = _abbr;
alias T FieldType;
}
mixin template structFields(T...) {
static if (!(T.length == 0)) {
mixin(T[0].FieldType.stringof ~ " " ~ T[0].name ~ ";");
mixin structFields!(T[1..$]);
}
}
string makeSwitchStatements(F...)() {
/* certain assumptions about variable names are being made here,
* namely, 'record' and 'contents'
*/
char[] result;
foreach (t; F) {
static if (t.FieldType.stringof == "string")
result ~= `case "`~t.abbr~`":`~
`record.`~t.name~`=cast(string)(contents);`~
`break;`.dup;
else
result ~= `case "`~t.abbr~`":`~
`record.`~t.name~`=to!(`~t.FieldType.stringof~`)(contents);`~
`break;`.dup;
}
result ~= `default: break;`.dup;
return cast(string)result;
}
auto fields(string header_line) {
return splitter(header_line[3..$], '\t');
}
/*
generates 'parse' method which parses given string and
fills corresponding struct fields
*/
mixin template parseStaticMethod(string struct_name, Field...) {
static auto parse(string line) {
mixin(struct_name ~ " record;");
foreach (field; fields(line)) {
if (field.length < 3) {
continue;
}
if (field[2] != ':') {
continue;
}
string contents = field[3..$];
switch (field[0..2]) {
mixin(makeSwitchStatements!Field());
}
}
return record;
}
}
string serializeFields(Field...)() {
static if (Field.length > 0) {
char[] str = `if (`~Field[0].name~` != `~Field[0].FieldType.stringof~`.init) {`.dup;
str ~= `sink.write("\t` ~ Field[0].abbr ~ `:");`.dup;
str ~= `sink.write(`~Field[0].name~`);`.dup;
str ~= `}`.dup;
return str.idup ~ serializeFields!(Field[1..$])();
} else {
return "";
}
}
/*
generates 'toSam' method which converts a struct
to SAM header line
*/
mixin template toSamMethod(string line_prefix, Field...) {
void toSam(Sink)(auto ref Sink sink) const if (isSomeSink!Sink) {
sink.write(line_prefix);
mixin(serializeFields!Field());
}
}
string generateHashExpression(Field...)() {
char[] res;
foreach (t; Field) {
res ~= "result = 31 * result + " ~
"typeid(" ~ t.name ~ ").getHash(&" ~ t.name ~ ");".dup;
}
return res.idup;
}
mixin template toHashMethod(string struct_name, string id_field, Field...) {
static if (id_field != null) {
hash_t toHash() const nothrow @safe{
hash_t result = 1;
mixin(generateHashExpression!Field());
return result;
}
mixin("int opCmp(const ref " ~ struct_name ~ " other) " ~
" const pure nothrow @safe" ~
"{" ~
" return " ~ id_field ~ " < other." ~ id_field ~ " ? -1 : " ~
" " ~ id_field ~ " > other." ~ id_field ~ " ? 1 : 0;" ~
"}");
}
}
string opEqualsExpression(Field...)() {
char[] result = Field[0].name ~ " == other.".dup ~ Field[0].name;
foreach (t; Field[1..$]) {
result ~= " && " ~ t.name ~ " == other.".dup ~ t.name;
}
return result.idup;
}
mixin template opEqualsMethod(string struct_name, Field...) {
mixin("bool opEquals(const ref " ~ struct_name ~ " other)" ~
" pure const @safe nothrow" ~
"{" ~
" return " ~ opEqualsExpression!Field() ~ ";" ~
"}");
mixin("bool opEquals(" ~ struct_name ~ " other)" ~
" pure const @safe nothrow" ~
"{" ~
" return " ~ opEqualsExpression!Field() ~ ";" ~
"}");
}
mixin template getSetIDMethods(string id_field) {
static if (id_field != null) {
auto getID() const pure nothrow @safe {
mixin("return " ~ id_field ~";");
}
mixin("void setID(typeof("~id_field~") id) pure nothrow @safe { " ~ id_field ~ " = id; }");
}
}
string generateToMsgpackMethod(Field...)() {
char[] method = "packer.beginMap(" ~ to!string(Field.length) ~ ");".dup;
foreach (t; Field) {
method ~= "packer.pack(`" ~ t.abbr ~ "`);".dup;
method ~= "packer.pack(" ~ t.name ~ ");".dup;
}
return method.idup;
}
mixin template toMsgpackMethod(Field...) {
void toMsgpack(Packer)(ref Packer packer) const {
mixin(generateToMsgpackMethod!Field());
}
}
mixin template HeaderLineStruct(string struct_name,
string line_prefix,
string id_field,
Field...)
{
mixin(`struct `~struct_name~`{
mixin structFields!Field;
mixin parseStaticMethod!(struct_name, Field);
mixin toSamMethod!(line_prefix, Field);
mixin toHashMethod!(struct_name, id_field, Field);
mixin opEqualsMethod!(struct_name, Field);
mixin getSetIDMethods!id_field;
mixin toMsgpackMethod!Field;
}`);
}
}
mixin HeaderLineStruct!("HdLine", "@HD", null,
Field!("format_version", "VN"),
Field!("sorting_order", "SO"));
mixin HeaderLineStruct!("SqLine", "@SQ", "name",
Field!("name", "SN"),
Field!("length", "LN", uint),
Field!("assembly", "AS"),
Field!("md5", "M5"),
Field!("species", "SP"),
Field!("uri", "UR"),
Field!("alternate_haplotype", "AH"));
mixin HeaderLineStruct!("RgLine", "@RG", "identifier",
Field!("identifier", "ID"),
Field!("sequencing_center", "CN"),
Field!("description", "DS"),
Field!("date", "DT"),
Field!("flow_order", "FO"),
Field!("key_sequence", "KS"),
Field!("library", "LB"),
Field!("programs", "PG"),
Field!("predicted_insert_size", "PI", int),
Field!("platform", "PL"),
Field!("platform_unit", "PU"),
Field!("sample", "SM"));
mixin HeaderLineStruct!("PgLine", "@PG", "identifier",
Field!("identifier", "ID"),
Field!("name", "PN"),
Field!("command_line", "CL"),
Field!("previous_program", "PP"),
Field!("program_version", "VN")); // version is a keyword in D
unittest {
import std.algorithm;
import std.stdio;
writeln("Testing @HD line parsing...");
auto hd_line = HdLine.parse("@HD\tVN:1.0\tSO:coordinate");
assert(hd_line.format_version == "1.0");
assert(hd_line.sorting_order == "coordinate");
writeln("Testing @SQ line parsing...");
auto sq_line = SqLine.parse("@SQ\tSN:NC_007605\tLN:171823\tM5:6743bd63b3ff2b5b8985d8933c53290a\tUR:ftp://.uk/vol1/ftp/technical/reference/phase2_reference_assembly_sequence/hs37d5.fa.gz\tAS:NCBI37\tSP:HUMAN");
assert(sq_line.name == "NC_007605");
assert(sq_line.length == 171823);
assert(sq_line.md5 == "6743bd63b3ff2b5b8985d8933c53290a");
assert(sq_line.uri.endsWith("hs37d5.fa.gz"));
assert(sq_line.assembly == "NCBI37");
assert(sq_line.species == "HUMAN");
writeln("Testing @RG line parsing...");
auto rg_line = RgLine.parse("@RG\tID:ERR016155\tLB:HUMgdtRAGDIAAPE\tSM:HG00125\tPI:488\tCN:BGI\tPL:ILLUMINA\tDS:SRP001294");
assert(rg_line.identifier == "ERR016155");
assert(rg_line.library == "HUMgdtRAGDIAAPE");
assert(rg_line.sample == "HG00125");
assert(rg_line.predicted_insert_size == 488);
assert(rg_line.sequencing_center == "BGI");
assert(rg_line.platform == "ILLUMINA");
assert(rg_line.description == "SRP001294");
writeln("Testing @PG line parsing...");
auto pg_line = PgLine.parse("@PG\tID:bam_calculate_bq\tPN:samtools\tPP:bam_recalibrate_quality_scores\tVN:0.1.17 (r973:277)\tCL:samtools calmd -Erb $bam_file $reference_fasta > $bq_bam_file");
assert(pg_line.identifier == "bam_calculate_bq");
assert(pg_line.name == "samtools");
assert(pg_line.previous_program == "bam_recalibrate_quality_scores");
assert(pg_line.program_version == "0.1.17 (r973:277)");
assert(pg_line.command_line.endsWith("$bq_bam_file"));
}
// workaround for LDC bug #217
struct ValueRange(T) {
this(T[string] dict, string[] ids) {
_dict = dict;
_ids = ids;
}
private {
T[string] _dict;
string[] _ids;
}
ref T front() @property { return _dict[_ids[0]]; }
ref T back() @property { return _dict[_ids[$-1]]; }
bool empty() @property { return _ids.length == 0; }
void popFront() { _ids = _ids[1 .. $]; }
void popBack() { _ids = _ids[0 .. $ - 1]; }
ref T opIndex(size_t i) { return _dict[_ids[i]]; }
size_t length() @property { return _ids.length; }
ValueRange save() @property { return ValueRange(_dict, _ids[]); }
}
/// Common class for storing header lines
class HeaderLineDictionary(T) {
invariant() {
assert(_index_to_id.length == _dict.length);
assert(_id_to_index.length == _dict.length);
/*
foreach(id, index; _id_to_index) {
assert(_index_to_id[index] == id);
}
*/
}
///
ref inout(T) opIndex(string id) inout {
return _dict[id];
}
///
void opIndexAssign(T line, string id) {
_dict[id] = line;
}
///
const(T)* opIn_r(string id) const {
return id in _dict;
}
/// Append a line
bool add(T line) {
auto id = line.getID();
if (id !in _dict) {
_dict[id] = line;
_id_to_index[id] = _index_to_id.length;
_index_to_id ~= id;
return true;
}
return false;
}
/// Remove a line with identifier $(D id).
bool remove(string id) {
if (id in _dict) {
auto old_len = _dict.length;
for (auto j = _id_to_index[id]; j < old_len - 1; ++j) {
_index_to_id[j] = _index_to_id[j + 1];
_id_to_index[_index_to_id[j]] = j;
}
_index_to_id.length = _index_to_id.length - 1;
_dict.remove(id);
_id_to_index.remove(id);
return true;
}
return false;
}
///
int opApply(scope int delegate(ref T line) dg) {
foreach (size_t i; 0 .. _dict.length) {
auto res = dg(_dict[_index_to_id[i]]);
if (res != 0) {
return res;
}
}
return 0;
}
///
int opApply(scope int delegate(T line) dg) const {
foreach (size_t i; 0 .. _dict.length) {
auto res = dg(_dict[_index_to_id[i]]);
if (res != 0) {
return res;
}
}
return 0;
}
///
int opApply(scope int delegate(ref size_t index, ref T line) dg) {
foreach (size_t i; 0 .. _dict.length) {
auto res = dg(i, _dict[_index_to_id[i]]);
if (res != 0) {
return res;
}
}
return 0;
}
/// Clear the dictionary
void clear() {
_dict = null;
_id_to_index = null;
_index_to_id.length = 0;
}
static assert(isRandomAccessRange!(ValueRange!T));
/// Returns: range of lines
ValueRange!T values() @property {
return ValueRange!T(_dict, _index_to_id);
}
/// Returns: number of stored lines
size_t length() @property const {
return _dict.length;
}
protected {
T[string] _dict;
string[] _index_to_id;
size_t[string] _id_to_index;
}
}
/// Dictionary of @SQ lines.
final class SqLineDictionary : HeaderLineDictionary!SqLine
{
///
ref inout(SqLine) getSequence(size_t index) inout {
return _dict[_index_to_id[index]];
}
///
int getSequenceIndex(string sequence_name) {
size_t* ind = sequence_name in _id_to_index;
return (ind is null) ? -1 : cast(int)(*ind);
}
}
/// Dictionary of @RG lines
alias HeaderLineDictionary!RgLine RgLineDictionary;
/// Dictionary of @PG lines
alias HeaderLineDictionary!PgLine PgLineDictionary;
/// Represents SAM header
class SamHeader {
///
enum DEFAULT_FORMAT_VERSION = "1.3";
/// Construct empty SAM header
this() {
sequences = new SqLineDictionary();
read_groups = new RgLineDictionary();
programs = new PgLineDictionary();
format_version = DEFAULT_FORMAT_VERSION;
}
/// Parse SAM header given in plain text.
this(string header_text) {
read_groups = new RgLineDictionary();
programs = new PgLineDictionary();
format_version = DEFAULT_FORMAT_VERSION;
import core.memory;
core.memory.GC.disable();
bool parsed_first_line = false;
size_t n_sq_lines = 0;
foreach (line; splitter(header_text, '\n')) {
if (line.length < 3) {
continue;
}
if (!parsed_first_line && line[0..3] == "@HD") {
auto header_line = HdLine.parse(line);
if (header_line.sorting_order.length > 0) {
try {
sorting_order = to!SortingOrder(header_line.sorting_order);
} catch (ConvException e) {
sorting_order = SortingOrder.unknown;
// FIXME: should we do that silently?
}
} else {
sorting_order = SortingOrder.unknown;
}
format_version = header_line.format_version;
}
enforce(line[0] == '@', "Header lines must start with @");
switch (line[1]) {
case 'S':
enforce(line[2] == 'Q');
++n_sq_lines;
break;
case 'R':
enforce(line[2] == 'G');
auto rg_line = RgLine.parse(line);
if (!read_groups.add(rg_line)) {
stderr.writeln("duplicating @RG line ", rg_line.identifier);
}
break;
case 'P':
enforce(line[2] == 'G');
auto pg_line = PgLine.parse(line);
if (!programs.add(pg_line)) {
stderr.writeln("duplicating @PG line ", pg_line.identifier);
}
break;
case 'H':
enforce(line[2] == 'D');
break;
case 'C':
enforce(line[2] == 'O');
comments ~= line[4..$];
break;
default:
assert(0);
}
parsed_first_line = true;
}
if (!parsed_first_line) {
format_version = DEFAULT_FORMAT_VERSION;
}
_header_text = header_text;
if (n_sq_lines <= 1000000)
_parseSqLines(); // parse immediately for typical files
core.memory.GC.enable();
}
/// Format version
string format_version;
/// Sorting order
SortingOrder sorting_order = SortingOrder.unknown;
/// Dictionary of @SQ lines.
/// Removal is not allowed, you can only replace the whole dictionary.
SqLineDictionary sequences() @property {
if (_sequences is null)
_parseSqLines();
return _sequences;
}
void sequences(SqLineDictionary dict) @property {
_sequences = dict;
}
private SqLineDictionary _sequences;
private string _header_text;
private void _parseSqLines() {
import core.memory;
core.memory.GC.disable();
_sequences = new SqLineDictionary();
foreach (line; splitter(_header_text, '\n')) {
if (line.length < 3)
continue;
if (line[0 .. 3] != "@SQ")
continue;
auto sq_line = SqLine.parse(line);
if (!_sequences.add(sq_line)) {
stderr.writeln("duplicating @SQ line ", sq_line.name);
}
}
_header_text = null;
core.memory.GC.enable();
}
/// Dictionary of @RG lines
RgLineDictionary read_groups;
/// Dictionary of @PG lines
PgLineDictionary programs;
/// Array of @CO lines
string[] comments;
/// Zero-based index of sequence.
/// If such sequence does not exist in the header, returns -1.
int getSequenceIndex(string sequence_name) {
return sequences.getSequenceIndex(sequence_name);
}
///
SqLine getSequence(size_t index) {
return sequences.getSequence(index);
}
/// Get header text representation in SAM format (includes trailing '\n')
string text() @property {
return to!string(this);
}
/// Header text representation in SAM ("%s") or JSON format ("%j").
/// $(BR)
/// Includes trailing '\n'.
void toString(scope void delegate(const(char)[]) sink, FormatSpec!char fmt) {
if (fmt.spec == 's')
toSam(sink);
else if (fmt.spec == 'j')
toJson(sink);
else
throw new FormatException("unknown format specifier");
}
void toSam(Sink)(auto ref Sink sink) if (isSomeSink!Sink) {
sink.write("@HD\tVN:");
sink.write(format_version);
if (sorting_order != SortingOrder.unknown) {
sink.write("\tSO:");
sink.write(to!string(sorting_order));
}
sink.write('\n');
for (size_t i = 0; i < sequences.length; i++) {
auto sq_line = getSequence(i);
sq_line.toSam(sink);
sink.write('\n');
}
foreach (rg_line; read_groups) {
rg_line.toSam(sink);
sink.write('\n');
}
foreach (pg_line; programs) {
pg_line.toSam(sink);
sink.write('\n');
}
foreach (comment; comments) {
sink.write("@CO\t");
sink.write(comment);
sink.write('\n');
}
}
void toJson(Sink)(auto ref Sink sink) if (isSomeSink!Sink) {
JSONValue[string] result;
result["format_version"].str = format_version;
if (sorting_order != SortingOrder.unknown) {
result["sorting_order"].str = sorting_order.to!string;
}
auto tmp = new JSONValue[sequences.length];
for (auto i = 0; i < sequences.length; i++) {
auto line = getSequence(i);
JSONValue[string] sq;
sq["sequence_name"].str = line.name;
sq["sequence_length"].uinteger = line.length;
sq["assembly"].str = line.assembly;
sq["md5"].str = line.md5;
sq["species"].str = line.species;
sq["uri"].str = line.uri;
tmp[i].object = sq;
}
result["sq_lines"].array = tmp.dup;
tmp.length = read_groups.length;
size_t i = 0;
foreach (line; read_groups) {
JSONValue[string] sq;
sq["identifier"].str = line.identifier;
sq["sequencing_center"].str = line.sequencing_center;
sq["description"].str = line.description;
sq["date"].str = line.date;
sq["flow_order"].str = line.flow_order;
sq["key_sequence"].str = line.key_sequence;
sq["library"].str = line.library;
sq["programs"].str = line.programs;
sq["predicted_insert_size"].integer = line.predicted_insert_size;
sq["platform"].str = line.platform;
sq["platform_unit"].str = line.platform_unit;
sq["sample"].str = line.sample;
tmp[i++].object = sq;
}
result["rg_lines"].array = tmp.dup;
tmp.length = programs.length;
i = 0;
foreach (line; programs) {
JSONValue[string] sq;
sq["identifier"].str = line.identifier;
sq["program_name"].str = line.name;
sq["command_line"].str = line.command_line;
sq["previous_program"].str = line.previous_program;
sq["program_version"].str = line.program_version;
tmp.array[i++].object = sq;
}
result["pg_lines"].array = tmp;
JSONValue json;
json.object = result;
static if (__VERSION__ < 2072)
sink.write(toJSON(&json));
else
sink.write(toJSON(json));
}
/// Packs message in the following format:
/// $(BR)
/// MsgPack array with elements
/// $(OL
/// $(LI format version - string)
/// $(LI sorting order - string)
/// $(LI @SQ lines - array of dictionaries)
/// $(LI @RG lines - array of dictionaries)
/// $(LI @PG lines - array of dictionaries))
/// $(BR)
/// Dictionary keys are the same as in SAM format.
void toMsgpack(Packer)(ref Packer packer) const {
enforce(_sequences !is null, "failed to call msgpack");
packer.beginArray(5);
packer.pack(format_version);
packer.pack(to!string(sorting_order));
packer.beginArray(_sequences.length);
foreach (sq; _sequences)
packer.pack(sq);
packer.beginArray(read_groups.length);
foreach (rg; read_groups)
packer.pack(rg);
packer.beginArray(programs.length);
foreach (pg; programs)
packer.pack(pg);
}
}
/// Sorting order
enum SortingOrder {
unknown, ///
unsorted, ///
coordinate, ///
queryname ///
}
unittest {
auto header = new SamHeader();
import std.stdio;
assert(header.text == "@HD\tVN:1.3\n");
auto sequence = SqLine("abc", 123123);
header.sequences.add(sequence);
assert(header.text == "@HD\tVN:1.3\n@SQ\tSN:abc\tLN:123123\n");
header.sorting_order = SortingOrder.coordinate;
header.format_version = "1.2";
assert(header.text == "@HD\tVN:1.2\tSO:coordinate\n@SQ\tSN:abc\tLN:123123\n");
assert(header.getSequenceIndex("abc") == 0);
assert(header.getSequenceIndex("bcd") == -1);
header.sequences.clear();
sequence = SqLine("bcd", 678);
sequence.uri = "http://lorem.ipsum";
header.sequences.add(sequence);
header.format_version = "1.4";
assert(header.text == "@HD\tVN:1.4\tSO:coordinate\n@SQ\tSN:bcd\tLN:678\tUR:http://lorem.ipsum\n");
header.sequences.add(SqLine("def", 321));
assert(header.getSequenceIndex("abc") == -1);
assert(header.getSequenceIndex("bcd") == 0);
assert(header.getSequenceIndex("def") == 1);
header.sequences.remove("bcd");
assert(header.getSequenceIndex("abc") == -1);
assert(header.getSequenceIndex("bcd") == -1);
assert(header.getSequenceIndex("def") == 0);
assert(header.text == "@HD\tVN:1.4\tSO:coordinate\n@SQ\tSN:def\tLN:321\n");
auto dict = new SqLineDictionary();
dict.add(SqLine("yay", 111));
dict.add(SqLine("zzz", 222));
auto zzz = dict["zzz"]; // TODO: make 'dict["zzz"].uri = ...' work
zzz.uri = "ftp://nyan.cat";
dict["zzz"] = zzz;
header.sequences = dict;
assert(header.text ==
"@HD\tVN:1.4\tSO:coordinate\n@SQ\tSN:yay\tLN:111\n@SQ\tSN:zzz\tLN:222\tUR:ftp://nyan.cat\n");
assert(header.sequences == dict);
header.sequences.remove("yay");
header.sequences.remove("zzz");
header.comments ~= "this is a comment";
assert(header.text == "@HD\tVN:1.4\tSO:coordinate\n@CO\tthis is a comment\n");
}
|