/usr/include/Bpp/Seq/App/SequenceApplicationTools.h is in libbpp-seq-dev 2.0.3-1.
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 | //
// File: SequenceApplicationTools.h
// Created by: Julien Dutheil
// Created on: Fri Oct 21 13:13
// from file old ApplicationTools.h created on Sun Dec 14 09:36:26 2003
//
/*
Copyright or © or Copr. CNRS, (November 17, 2004)
This software is a computer program whose purpose is to provide classes
for sequences analysis.
This software is governed by the CeCILL license under French law and
abiding by the rules of distribution of free software. You can use,
modify and/ or redistribute the software under the terms of the CeCILL
license as circulated by CEA, CNRS and INRIA at the following URL
"http://www.cecill.info".
As a counterpart to the access to the source code and rights to copy,
modify and redistribute granted by the license, users are provided only
with a limited warranty and the software's author, the holder of the
economic rights, and the successive licensors have only limited
liability.
In this respect, the user's attention is drawn to the risks associated
with loading, using, modifying and/or developing or reproducing the
software by the user in light of its specific status of free software,
that may mean that it is complicated to manipulate, and that also
therefore means that it is reserved for developers and experienced
professionals having in-depth computer knowledge. Users are therefore
encouraged to load and test the software's suitability as regards their
requirements in conditions enabling the security of their systems and/or
data to be ensured and, more generally, to use and operate it in the
same conditions as regards security.
The fact that you are presently reading this means that you have had
knowledge of the CeCILL license and that you accept its terms.
*/
#ifndef _SEQUENCEAPPLICATIONTOOLS_H_
#define _SEQUENCEAPPLICATIONTOOLS_H_
#include "../Alphabet.all"
#include "../Container.all"
#include "../GeneticCode.all"
#include "../StateProperties.all"
namespace bpp
{
/**
* @brief This class provides some common tools for applications.
*
* The functions parse some option file, create corresponding objects and send
* a pointer toward it.
*
* The option files are supposed to follow this simple format:
* @code
* parameterName = parameterContent
* @endcode
* with one parameter per line.
*
* @see ApplicationTools
*/
class SequenceApplicationTools
{
public:
SequenceApplicationTools() {}
virtual ~SequenceApplicationTools() {}
public:
/**
* @brief Build an Alphabet object according to options.
*
* Options used are:
* - alphabet = [DNA|RNA|Protein], the alphabet type to use.
* = [DNA|RNA|Protein](length=n) a word-alphabet of
* words with length n
* = [EchinodermMitochondrialCodonAlphabet
* | InvertebrateMitochondrialCodonAlphabet
* | InvertebrateMitochondrialCodonAlphabet
* | StandardCodonAlphabet
* | VertebrateMitochondrialCodonAlphabet]([alphn=NA|RNA])
* a codon-alphabet
*
* @param params The attribute map where options may be found.
* @param suffix A suffix to be applied to each attribute name.
* @param suffixIsOptional Tell if the suffix is absolutely required.
* @param verbose Print some info to the 'message' output stream.
* @param allowGeneric Tell if generic alphabets can be used.
* @return A new Alphabet object according to options specified.
*/
static Alphabet * getAlphabet(
std::map<std::string, std::string> & params,
const std::string & suffix = "",
bool suffixIsOptional = true,
bool verbose = true,
bool allowGeneric = false) throw (Exception);
/**
* @brief Build a Geneticcode object according to options.
*
* @param alphabet pointer to the NucleicAlphabet
* @param description for the name of the GeneticCode:
* [EchinodermMitochondrialGeneticCode
* | InvertebrateMitochondrialGeneticCode
* | InvertebrateMitochondrialGeneticCode
* | StandardGeneticCode
* | VertebrateMitochondrialGeneticCode]
* @return A new GeneticCode object
* @throw Exception in case of bad description.
*/
static GeneticCode * getGeneticCode(const NucleicAlphabet* alphabet, const std::string& description) throw (Exception);
/**
* @brief Build a AlphabetIndex2<double> object for amino acid
* distance according to options.
*
* @param description name of the distance
* [BLOSUM50,
* | GranthamAAChemicalDistance
* | MiyataAAChemicalDistance]
* @return A new AlphabetIndex2<double> object.
* @throw Exception in case of bad description.
*/
static AlphabetIndex2<double>* getAADistance(const std::string& description) throw (Exception);
/**
* @brief Build a SequenceContainer object according to options.
*
* The sequences do not have to be aligned.
* The supported sequence formats are Fasta, DCSE, Clustal, Mase, Phylip and GenBank.
*
* See the Bio++ program suite manual for a full description of the syntax.
*
* @param alpha The alphabet to use in the container.
* @param params The attribute map where options may be found.
* @param suffix A suffix to be applied to each attribute name.
* @param suffixIsOptional Tell if the suffix is absolutely required.
* @param verbose Print some info to the 'message' output stream.
* @return A new VectorSequenceContainer object according to options specified.
* @see getSiteContainer to read an alignment.
*/
static SequenceContainer * getSequenceContainer(
const Alphabet * alpha,
std::map<std::string, std::string> & params,
const std::string & suffix = "",
bool suffixIsOptional = true,
bool verbose = true);
/**
* @brief Build a SiteContainer object according to options.
*
* Sequences in file must be aligned.
* The supported sequence formats are Fasta, DCSE, Clustal, Mase and Phylip.
*
* See the Bio++ program suite manual for a full description of the syntax.
*
* @param alpha The alphabet to use in the container.
* @param params The attribute map where options may be found.
* @param suffix A suffix to be applied to each attribute name.
* @param suffixIsOptional Tell if the suffix is absolutely required.
* @param verbose Print some info to the 'message' output stream.
* @return A new VectorSiteContainer object according to options specified.
*/
static VectorSiteContainer* getSiteContainer(
const Alphabet * alpha,
std::map<std::string, std::string> & params,
const std::string & suffix = "",
bool suffixIsOptional = true,
bool verbose = true);
/**
* @brief Retrieves sites suitable for the analysis.
*
* Options used are:
* - sequence.sites_to_use = [all|complete|nogap].
*
* If the 'complete' option is used, only fully resolve site will be taken
* into account.
* If the 'nogap' option is used, only sites without gap will be taken into
* account.
* If 'gapAsUnknown' is set to true and the all option is selected, gaps will
* be changed to 'unknown' character is sequences.
*
* - sequence.max_gap_allowed = [57%|30]
* If a % sign fallow the number, it is taken to be a frequence (in percent).
* This specify the maximum amount of gaps allowed for each site.
* Sites not satisfying this amount will be removed.
* A value of 100% will remove all gap-only sites, a value >100% will keep all sites.
*
* @param allSites The site container from which sites must be retrieved.
* @param params The attribute map where options may be found.
* @param suffix A suffix to be applied to each attribute name.
* @param suffixIsOptional Tell if the suffix is absolutely required.
* @param gapAsUnknown Convert gaps to unknown characters.
* @param verbose Print some info to the 'message' output stream.
* @return A new VectorSiteContainer object containing sites of interest.
*/
static VectorSiteContainer* getSitesToAnalyse(
const SiteContainer & allSites,
std::map<std::string, std::string> & params,
std::string suffix = "",
bool suffixIsOptional = true,
bool gapAsUnknown = true,
bool verbose = true);
/**
* @brief Write a sequence file according to options.
*
* The supported sequence formats are Fasta and Mase.
*
* See the Bio++ program suite manual for a full description of the syntax.
*
* @see writeSequenceFile(SiteContainer) for writing alignments, with more output formats.
*
* @param sequences The sequences to write.
* @param params The attribute map where options may be found.
* @param suffix A suffix to be applied to each attribute name.
* @param verbose Print some info to the 'message' output stream.
*/
static void writeSequenceFile(
const SequenceContainer& sequences,
std::map<std::string, std::string>& params,
const std::string & suffix = "",
bool verbose = true);
/**
* @brief Write a sequence alignment file according to options.
*
* The supported sequence formats are Fasta, Mase and Phylip.
*
* See the Bio++ program suite manual for a full description of the syntax.
*
* @param sequences The aligned sequences to write.
* @param params The attribute map where options may be found.
* @param suffix A suffix to be applied to each attribute name.
* @param verbose Print some info to the 'message' output stream.
*/
static void writeAlignmentFile(
const SiteContainer& sequences,
std::map<std::string, std::string>& params,
const std::string & suffix = "",
bool verbose = true);
};
} //end of namespace bpp.
#endif //_SEQUENCEAPPLICATIONTOOLS_H_
|