Call.hpp

Go to the documentation of this file.

// Copyright 2010 Complete Genomics, Inc.
//
// Licensed under the Apache License, Version 2.0 (the "License"); you
// may not use this file except in compliance with the License. You
// may obtain a copy of the License at
//
// http://www.apache.org/licenses/LICENSE-2.0
//
// Unless required by applicable law or agreed to in writing, software
// distributed under the License is distributed on an "AS IS" BASIS,
// WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
// implied. See the License for the specific language governing
// permissions and limitations under the License.

#ifndef CGATOOLS_VARIANTS_CALL_HPP_
#define CGATOOLS_VARIANTS_CALL_HPP_ 1


#include "cgatools/core.hpp"
#include "cgatools/reference/CrrFile.hpp"
#include "cgatools/util/DelimitedFile.hpp"
#include <string>

namespace cgatools { namespace variants {

    struct Call
    {
    public:
        enum VarQuality
        {
            VAR_QUALITY_EMPTY = 0,
            VAR_QUALITY_LOW   = 1,
            VAR_QUALITY_HIGH  = 2
        };

        class VarQualityField : public util::DelimitedFieldParser
        {
        public:
            VarQualityField(const std::string& name, VarQuality* varQuality);

            void parse(const char* first, const char* last);

        private:
            VarQuality* varQuality_;
        };

        class TotalScoreField : public util::DelimitedFieldParser
        {
        public:
            TotalScoreField(
                const std::string& name,
                int32_t* varScoreVAF,
                int32_t* varScoreEAF);

            void parse(const char* first, const char* last);

        private:
            int32_t* varScoreVAF_;
            int32_t* varScoreEAF_;
        };

        static const uint16_t ALL_HAPLOTYPES;

        static const uint16_t UNKNOWN_PLOIDY;

        static const int32_t EMPTY_SCORE;

        Call ();

        std::string calledSequence(const reference::CrrFile& crr) const;

        std::string refSequence(const reference::CrrFile& crr) const;

        bool isRefConsistent(const reference::CrrFile& crr) const;

        bool hasNoCalls() const;

        void addFieldParsers(util::DelimitedFile& df, const reference::CrrFile& crr);

        std::ostream& write(std::ostream& out,
                            const reference::CrrFile& crr,
                            const char sep = '\t') const;

        static const char* varQualityToString(const VarQuality varQuality);

        static VarQuality parseVarQuality(const char* first, const char* last);

        static std::string getHeader (const char separator = '\t');

        uint32_t locus_;

        uint16_t ploidy_;

        uint16_t haplotype_;

        reference::Range range_;

        std::string varType_;

        std::string reference_;

        std::string alleleSeq_;

        int32_t varScoreVAF_;

        int32_t varScoreEAF_;

        VarQuality varQuality_;

        std::string hapLink_;

        std::string xRef_;
    };

    void upgradeOldFieldValues(Call& c);

    std::ostream& operator<<(std::ostream& out, const Call::VarQuality& varQuality);

} } // cgatools::variants

#endif // CGATOOLS_VARIANTS_CALL_HPP_

---