+ extended manual to describe output file format
[qpalma.git] / doc / qpalma-manual.tex
index 89c6e32..806c3d3 100644 (file)
@@ -169,7 +169,7 @@ the splice site predictions:
 \item \qparam{allowed\_fragments} - A list of the form ``[1,2,4]'' describing the valid file name numbers. See description below.
 \item \qparam{half\_window\_size} - Given an alignment seed position for a
 given read we cut out the area [1500-seed\_pos,seed\_pos+1500].
-\item \qparam{output\_format} - The output format can be either blat, ShoRe or
+\item \qparam{output\_format} - The output format can be either blat-like, ShoRe or
 mGene.
 \item \qparam{prb\_offset} - We expect the quality values to be saved as ascii
 strings so the quality is calulated via ord(qchar)-prb\_offset ($ord(\cdot)$
@@ -301,6 +301,31 @@ We supply a script ``spliceScoresConverter.py'' for conversion of ascii to
 binary files. You can use this script as a template to make your own scoring
 information files.
 
+
+\subsection{Alignment result file}
+
+The result file for the blat-like output format consists of lines with the following columns:
+
+\begin{itemize}
+\item id - the unique read id of the input file
+\item chromosome/contig number
+\item strand
+\item start position of alignment in target
+\item qStart
+\item qEnd
+\item tStart
+\item tEnd
+\item number of exons
+\item qExonSizes
+\item qStarts
+\item qEnds
+\item tExonSizes
+\item tStarts
+\item tEnds
+\item number of matches in alignment
+\item number of gaps in alignment
+\end{itemize}
+
 \section{Remarks}
 
 The \QP project is licensed under the GPL. \\ \noindent