Debian Codegraph @

README.md

raw
1 BaitFisher-package: Design DNA hybrid enrichment baits
2 ======================================================
3
4 Table of contents:
5 - [About the BaitFisher package](#about-the-baitfisher-package)
6 - [Documentation](#documentation)
7 - [Compiling and installing BaitFisher and BaitFilter](#compiling-and-installing-baitfisher-and-baitfilter)
8 * [System requirements:](#system-requirements)
9 - [Quickstart](#quickstart)
10 - [Frequently aksed questions](#Frequently-aksed-questions)
11
12
13
14 About the BaitFisher package <a id="about-the-baitfisher-package"></a>
15 ----------------------------
16 The BaitFisher package consists of two programs: BaitFisher and BaitFilter.
17
18 BaitFisher was been designed to construct hybrid enrichment baits from multiple sequence alignments (MSAs) or annotated features in MSAs. The main goal of BaitFisher is to avoid redundancy in the construction of baits by designing fewer baits in conserved regions of the MSAs and designing more baits in variable regions. This makes use of the fact that hybrid enrichment baits can differ to some extends from the target region, which they should capture in the enrichment procedure. By specifying the allowed distance between baits and the sequences in the MSAs the user can control the allowed bait-to-target distance and the degree of reduction in the number of baits that are designed. See the BaitFisher paper for details.
19
20 BaitFilter was designed (i) to determine whether baits bind unspecifically to a reference genome, (ii) to filter baits that only have partial length matches to a reference genome, (iii) to determine the optimal bait region in a MSA and to convert baits to a format that can be uploaded at a bait constructing company. The optimal bait region can be the most conserved region in the MSA or the region with the highest number of sequences without gaps or ambiguous nucleotides.
21
22 Since performance was one of the major design goals, the BaitFisher and BaitFilter programs are both written in C++.
23
24 **Software development:**
25 Christoph Mayer,
26 Forschungsmuseum Alexander Koenig,
27 53113 Bonn,
28 Germany
29
30 **Main contributors:**
31 The main contributors to the development of the BaitFisher software are:
32 Christoph Mayer (\*), Oliver Niehuis (\*\*,\*), Manuela Sann (\*\*,\*)
33 (\*): Forschungsmuseum Alexander Koenig, 53113 Bonn, Germany
34 (\*\*): Institut für Biologie I (Zoologie), Albert-Ludwigs-Universität Freiburg, Germany
35
36
37 **When using BaitFisher please cite:**
38 Mayer, C., Sann, M., Donath, A., Meixner, M., Podsiadlowski, L., Peters, R.S., Petersen, M., Meusemann, K., Liere, K., Wägele, J.-W., Misof, B., Bleidorn, C., Ohl, M., Niehuis, O., 2016. BaitFisher: A Software Package for Multispecies Target DNA Enrichment Probe Design. Mol. Biol. Evol. doi:10.1093/molbev/msw056
39
40 Documentation <a id="documentation"></a>
41 -------------
42
43 A full manual for the BaitFisher package as PDF can be found in the "Documentation" folder.
44 Furthermore, example analyses can be found in the Example folder.
45
46 Online help for the BaitFisher and BaitFilter programs can be obtained by called he programs
47 as follows:
48
49 PATH/BaitFisher -h
50 PATH/BaitFileter -h
51
52
53
54 Compiling and installing BaitFisher and BaitFilter <a id="compiling-and-installing-baitfisher-and-baitfilter"></a>
55 --------------------------------------------------
56 ### System requirements: <a id="system-requirements"></a>
57
58 BaitFisher can be compiled on all platforms, which provide a C++ compiler that includes the following system header files: unistd.h, sys/stat.h, sys/types.h, dirent.h. These header files are standard header files on all unix systems such as Linux and Mac Os X. I also managed to compile BaitFisher and BaitFilter on Windows using the Mingw compiler (www.mingw.org).
59
60 ### Compiling BaitFisher and BaitFilter:
61
62 Please, unpack the BaitFisher archive you downloaded.
63
64 On the command line enter the BaitFisher-package-master directory. Now type "make" on the command line. This compiles the BaitFisher as well as the BaitFilter program. The executables of these to programs care called: BaitFisher-v1.2.7 and BaitFilter-v1.0.5. They can be copied on your computer to any place you like. To use these executables they have to be addressed with its full path, or they have to be placed somewhere where in your system path.
65
66
67 Quickstart <a id="quickstart"></a>
68 ----------
69 More content will me added soon.
70 For details please see the manual in the "Documentation" folder.
71
72 Frequently asked questions <a id="Frequently-aksed-questions"></a>
73 --------------------------
74 1. **BaitFisher does not design baits for all input files or all excised features. What is the reason for this?**
75
76 BaitFisher does not design baits for input files or excised features, which cannot host a tiling design of the required length.
77
78
79 2. **How can I determine the input files or excised features for which no baits have been designed?**
80
81 There are different reasons and therefore different messages why no baits have been designed for a given input file or excised feature.
82 A full list of the messages written to the screen (i.e. to standard output) and the underlying problem are listed here:
83
84 > **Message:**
85 *NOTICE: Skipping alignment since it is too short. Alignment length: the-number*
86 **Reason:**
87 In this case the alignment is shorter than the requested tiling design.
88 **Solution:**
89 If the size of the requested tiling design is decreased, it might be possible to design baits for this alignment.
90 Be sure that decreasing the size of the tiling design makes sense.
91
92 > **Message 1:**
93 *ALERT: Skipping feature-name feature since its overlap with the transcript is too short. Length of overlap: a-number*
94 **Message 2:**
95 *ALERT: Skipping feature-name feature since the alignment is too short after removing gap only positions. Length of overlap: a-number*
96 **Reason:**
97 The feature, the transcript or only the overlap of the two are too short to host a complete tiling design.
98 **Solution:**
99 If the size of the requested tiling design is decreased, it might be possible to design baits for this feature.
100
101 > **Message:**
102 *ALERT: Alignment contains #number features but no single valid bait region. (Details: see above.)*
103 **Reason:**
104 This message hints at the avbove messages.
105
106 > **Message:**
107 *ALERT: No valid bait region found for alignment:*
108 **Reason:**
109 There are two possibilities: If too many gaps appear in effect in every sequence, BaitFisher might not find a single sequence without gaps
110 in length of the requested tiling design.
111 If required taxa are specified, no region might exist in which the required taxa are present in the required length without gaps.
112 **Solution:**
113 If the size of the requested tiling design is decreased, it might be possible to design baits for this alignment.
114 If required taxa are removed, it might be possible to design baits for this alignment of it.
115
116 > **Message:**
117 *ALERT: No valid bait regions found for feature: name-of-feature*
118 **Reason:**
119 There are two possibilities: If too many gaps appear in effect in every sequence of an excised feature, BaitFisher might not find a single sequence without gaps
120 in length of the requested tiling design.
121 If required taxa are specified, no region might exist in which the required taxa are present in the required length without gaps.
122 **Solution:**
123 If the size of the requested tiling design is decreased, it might be possible to design baits for this feature.
124 If required taxa are removed, it might be possible to design baits for this features.
125
126 > **Message:**
127 *WARNING: For gene " gene-name " no entries where found in the gff file.
128 While this is possible, in most cases the reason is either a wrong attribute name for the
129 gene-name-field in the gff-file or the gene name specified in the sequence
130 name of the transcript alignment is incompatible to the gene names in the gff file.
131 It is recommended to check whether gene name " gene-name " occurs in the
132 gff file under the attribute name " the-gff-record-attribute-name-for-geneID ".
133 Note that the gene name as specified in the sequence name and the gene name in
134 the gff file have to match exactly. The attribute name specified in the parameter
135 file must be an exact (case insensitive) match to the attribute name in the gff file.*
136 **Reason:**
137 This message can only occur if features are excised from genes/alignments. In the configuration file the
138 user specifies which attribute contains the gene name. A gff file contains lines of features. Each line has
139 nine tab delimited columns. The last column contains the so called attributes. E.g. "Parent=FBtr0081133".
140 If BaitFisher found a gene name in the sequence name in the alignment file, it will search for all features
141 that belong to this gene. The features are identified by the gene name saved in an attribute.
142 If for a given gene name no entry is found in the gff file, this is in most cases due to a nameing problem,
143 or incompatibility of the gene names and the gff file. If no features with the given gene name are found,
144 no baits will be designed for this gene.
145 **Solution:**
146 Search for the gene-name given in the error message und verify that it can be found in the gff file.
147 Make sure it can be found under the the-gff-record-attribute-name-for-geneID specified in the configuration file.
148 In most cases this name is "parent".
149
150 > **Message:**
151 *WARNING: For gene " gene-name " no entries where found in the gff file that matched the specified feature name.
152 Since entries for this gene name have been found, but with different feature names, the problem could be the feature name
153 or the fact that features exist for this gene.*
154 **Reason:**
155 Here BaitFisher found entries with gene-name for the given attribute name, but they could not be found for the feaute
156 that was specified.
157 **Solution:**
158 Have a closer look at the lines containing the features you want to excise. If you want to excise CDS features
159 look at lines in the gff file containing this feature and check that the gene name is found under the correct attribute name.
160 Note that different features often have different attribute names for the name of the gene.
161 E.g. the gene or mRNA feature usually does not mention the gene name under the attribute name parent, but under the attribute name ID
162 since these features have no parent features. In contrast, the exon, CDS or intron features are usually
163 assigned to a parent gene and the attribute containing the gene name is often the parent attribute.
164 Check that the given gene-name is found for at least one feature of the given type (e.g. CDS) under
165 the specified attribute. If the gene name does not occur at all double check that the gff file and
166 the genome file are compatible and that the gene name has been determined correctly.
167
168
169 2. **How can I determine the input files or excised features for which baits have been designed?**
170
171 The bait-loci.txt file list all bait regions for which baits have been designed. The first column in this file is the alignment file name.
172 The second column is the gene name if applicalble, or again the alignment file name if no features have been excised.
173
174 On Unix system such as Linux or Mac, the unique filenames, gene names, or features can be easily determined on the command line:
175 In order to determine the alignment files for which baits have been designed you can use:
176 tail -n +2 loci_baits.txt | cut -f 1 | sort -u
177
178 In order to determine the genes for which baits have been designed you can use:
179 tail -n +2 loci_baits.txt | cut -f 2 | sort -u
180
181 In order to determine the feautes for which baits have been designed you can :
182 tail -n +2 loci_baits.txt | cut -f 2,3 | sort -u
183
184 &nbsp;
185
186
187 In case of questions not answered here, please contact the author Christoph Mayer.
188
189 >Last updated: September, 2017 by Christoph Mayer
190