File: tree_recon.cpp

package info (click to toggle)
seqan2 2.4.0%2Bdfsg-16
  • links: PTS, VCS
  • area: main
  • in suites: sid, trixie
  • size: 224,180 kB
  • sloc: cpp: 256,886; ansic: 91,672; python: 8,330; sh: 995; xml: 570; makefile: 252; awk: 51; javascript: 21
file content (212 lines) | stat: -rw-r--r-- 7,910 bytes parent folder | download | duplicates (7)
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
/*==========================================================================
               SeqAn - The Library for Sequence Analysis
                         http://www.seqan.de 
============================================================================
Copyright (C) 2007

This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Lesser General Public
License as published by the Free Software Foundation; either
version 3 of the License, or (at your option) any later version.

This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Lesser General Public License for more details.
==========================================================================*/

#include <seqan/basic.h>
#include <seqan/graph_msa.h>
#include <seqan/modifier.h>
#include <seqan/arg_parse.h>
#include <seqan/stream.h>

#include <iostream>


using namespace seqan;

//////////////////////////////////////////////////////////////////////////////////

template <typename TMat, typename TNames, typename TForwardIter>
void readPhylipMatrix(TMat & matrix,
                      TNames & names,
                      TForwardIter & iter)
{
    //typedef typename Value<TFile>::Type TValue;
    typedef typename Value<TMat>::Type TFloat;
    typedef typename Size<TMat>::Type TSize;
    //typedef typename Value<TNames>::Type TName;
    typedef typename Iterator<TMat, Standard>::Type TMatIter;

    if (atEnd(iter))
        throw UnexpectedEnd();

    // Parse the file and convert the internal ids.
    CharString buffer;
    while (!atEnd(iter))
    {
        clear(buffer);

        // Read "<blanks><num>\n"
        skipUntil(iter, NotFunctor<IsBlank>());
        readUntil(buffer, iter, OrFunctor<NotFunctor<IsGraph>, AssertFunctor<NotFunctor<IsNewline>, ParseError, Nothing> >());
        TSize nseq = lexicalCast<TSize>(buffer);
        skipLine(iter);

        // Allocate memory in matrix and names.
        resize(matrix, nseq * nseq);
        resize(names, nseq);

        TMatIter it = begin(matrix, Standard());
        for (TSize row = 0; row < nseq; ++row)
        {
            readUntil(names[row], iter, NotFunctor<IsGraph>());
            skipUntil(iter, OrFunctor<NotFunctor<IsSpace>, AssertFunctor<NotFunctor<IsNewline>, ParseError, Nothing> >());

            for (TSize col = 0; col < nseq; ++col, ++it)
            {
                clear(buffer);
                readUntil(buffer, iter, NotFunctor<IsGraph>());
                *it = lexicalCast<TFloat>(buffer);

                if (col + 1 < nseq)
                    skipUntil(iter, OrFunctor<NotFunctor<IsSpace>, AssertFunctor<NotFunctor<IsNewline>, ParseError, Nothing> >());
                else
                    skipLine(iter);
            }
        }
    }
}

//////////////////////////////////////////////////////////////////////////////////

int main(int argc, const char *argv[])
{
    // -----------------------------------------------------------------------
    // Setup argument parser
    // -----------------------------------------------------------------------
    seqan::ArgumentParser parser("tree_recon");

    // Set short description, version, date.
    setShortDescription(parser, "Tree reconstruction");
    setVersion(parser, SEQAN_APP_VERSION " [" SEQAN_REVISION "]");
    setDate(parser, SEQAN_DATE);
    setCategory(parser, "Phylogeneny");

    // Usage line and description.
    addUsageLine(parser, "[\\fIOPTIONS\\fP] \\fB-m\\fP \\fIIN.DIST\\fP");
    addDescription(parser, "Reconstruct phylogenetic tree from Phylip matrix \\fIIN.DIST\\fP.");

    addSection(parser, "Input / Output");
    addOption(parser, seqan::ArgParseOption("m", "matrix", "Name Phylip distance matrix file.  Must contain at least three species.", seqan::ArgParseArgument::INPUT_FILE, "FILE"));
    setRequired(parser, "matrix");
    setValidValues(parser, "matrix", "dist");
    addOption(parser, seqan::ArgParseOption("o", "out-file", "Path to write output to.", seqan::ArgParseArgument::OUTPUT_FILE, "FILE"));
    setDefaultValue(parser, "out-file", "tree.dot");
    setValidValues(parser, "out-file", "dot newick");

    addSection(parser, "Algorithm Options");
    addOption(parser, seqan::ArgParseOption("b", "build", "Tree building method. \\fInj\\fP: neighbour-joining, \\fImin\\fP: UPGMA single linkage, \\fImax\\fP: UPGMA complete linkage, \\fIavg\\fP: UPGMA average linkage, \\fIwavg\\fP: UPGMA weighted average linkage.  Neighbour-joining creates an unrooted tree.  We root that tree at the least joined pair.", seqan::ArgParseArgument::STRING, "METHOD"));
    setValidValues(parser, "build", "nj min max avg wavg");
    setDefaultValue(parser, "build", "nj");

    addTextSection(parser, "Contact and References");
    addListItem(parser, "For questions or comments, contact:", "Tobias Rausch <rausch@embl.de>");
    addListItem(parser, "SeqAn Homepage:", "http://www.seqan.de");

    // Parse command line.
    seqan::ArgumentParser::ParseResult res = seqan::parse(parser, argc, argv);
    // Only extract  options if the program will continue after parseCommandLine()
    if (res != seqan::ArgumentParser::PARSE_OK)
        return res == seqan::ArgumentParser::PARSE_ERROR;

    // Tree reconstruction
    typedef double TDistanceValue;
    typedef String<char> TName;
    typedef Size<TName>::Type TSize;

    // Read the options
    ::std::string infile;
    getOptionValue(infile, parser, "matrix");
    ::std::string outfile;
    getOptionValue(outfile, parser, "out-file");
    TSize build = 0;
    String<char> meth;
    getOptionValue(meth, parser, "build");
    if (meth == "nj") build = 0;
    else if (meth == "min") build = 1;
    else if (meth == "max") build = 2;
    else if (meth == "avg") build = 3;
    else if (meth == "wavg") build = 4;
    String<char> format;
    String<char> tmp = outfile;
    toLower(tmp);
    if (endsWith(tmp, ".dot"))
        format = "dot";
    else
        format = "newick";

    // Read the distance matrix
    String<TName> names;
    String<TDistanceValue> matrix;
    VirtualStream<char, Input> inPhylip(infile.c_str());
    DirectionIterator<VirtualStream<char, Input>, Input>::Type iter(directionIterator(inPhylip, Input()));
    readPhylipMatrix(matrix, names, iter);

    // Create the tree
    Graph<Tree<TDistanceValue> > tree;
    switch (build)
    {
        case 0:
            njTree(matrix, tree);
            break;
        case 1:
            upgmaTree(matrix, tree, UpgmaMin());
            break;
        case 2:
            upgmaTree(matrix, tree, UpgmaMax());
            break;
        case 3:
            upgmaTree(matrix, tree, UpgmaAvg());
            break;
        case 4:
            upgmaTree(matrix, tree, UpgmaWeightAvg());
            break;
        default:
            SEQAN_FAIL("unknown build method.");
    }

    VirtualStream<char, Output> oStream(outfile.c_str());

    if (format == "dot")
    {
        TSize nameLen = length(names);
        resize(names, numVertices(tree));
        // Add the label prefix for leaves
        for (TSize i = 0;i < nameLen; ++i)
        {
            TName tmpName = "label = \"";
            append(tmpName, names[i], Generous());
            appendValue(tmpName, '"');
            names[i] = tmpName;
        }

        // Append emty names for internal vertices
        for (; nameLen < length(names); ++nameLen)
            names[nameLen] = "label = \"\"";

        // Write the result
        writeRecords(oStream, tree, names, DotDrawing());
    }
    else if (format == "newick")
    {
        // If nj tree collapse the root
        if (build == 0)
            writeRecords(oStream, tree, names, true, NewickFormat());
        else
            writeRecords(oStream, tree, names, false, NewickFormat());
    }

    return 0;
}