outputs.tex 6.67 KB
Newer Older
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
\chapter{Generated outputs}
\section{General organization}

General output directory organization is  : 

\begin{forest}
  for tree={
    font=\ttfamily,
    %minimum height=0.75cm,
    %rounded corners=2pt,
    grow'=0,
    %inner ysep=8pt,
    child anchor=west,
    parent anchor=south,
    anchor=west,
    calign=first,
    %edge={rounded corners},
    edge path={
      \noexpand\path [draw, \forestoption{edge}]
Sylvain Jasson's avatar
Sylvain Jasson committed
20
      (!u.south west) +(15pt,0) |- (.child anchor)\forestoption{edge label};
21
22
23
24
25
26
27
    },
    before typesetting nodes={
      if n=1
        {insert before={[,phantom,minimum height=10pt]}}
        {}
    },
    fit=band,
Sylvain Jasson's avatar
Sylvain Jasson committed
28
    s sep=0pt, %vertical base separator... see also l
29
30
    before computing xy={l=20pt},
  }
Sylvain Jasson's avatar
Sylvain Jasson committed
31
32
33
[my\_directory \textsf{\textsl{(directory)}}
	[my\_name.1-point \textsf{\textsl{(directory)}}
		[my\_name.pedigree-and-probabilities.M\_1\_10.csv \textsf{\textsl{(text file)}} ]
34
35
		[...]
	]
Sylvain Jasson's avatar
Sylvain Jasson committed
36
37
38
	[my\_name.cache \textsf{\textsl{(directory)}}
		[my\_name.spell-marker.data \textsf{\textsl{(binary file)}}]
		[my\_name.spell-pedigree.data \textsf{\textsl{(binary file)}}]
39
	]
Sylvain Jasson's avatar
Sylvain Jasson committed
40
41
42
43
	[my\_name.n-point \textsf{\textsl{(directory)}}
		[ch1 \textsf{\textsl{(directory)}}
			[F2 \textsf{\textsl{(directory)}}
				[my\_name.ch1.F2.0.csv \textsf{\textsl{(text file)}}]
44
45
				[...]
			]
Sylvain Jasson's avatar
Sylvain Jasson committed
46
47
			[F2C \textsf{\textsl{(directory)}}
				[my\_name.ch1.F2.0.csv \textsf{\textsl{(text file)}}]
48
49
50
				[...]
			]
		]
Sylvain Jasson's avatar
Sylvain Jasson committed
51
		[ch2 \textsf{\textsl{(directory)}}
52
53
54
			[...]
		]
	]
Sylvain Jasson's avatar
Sylvain Jasson committed
55
56
57
58
59
60
61
62
63
	[my\_name.report \textsf{\textsl{(directory)}}
		[full\_map.txt \textsf{\textsl{(text file)}}]
		[t1 \textsf{\textsl{(directory)}}
			[ch1:124.34\_LOD.txt \textsf{\textsl{(text file)}}]
			[Model\_Cross\_ch1:114.96\_ch1:124.34\_ch1:150\_XtX\_inv.txt \textsf{\textsl{(text file)}}]
			[Model\_Cross\_ch1:114.96\_ch1:124.34\_ch1:150\_X.txt \textsf{\textsl{(text file)}}]
			[t1\_report.txt \textsf{\textsl{(text file)}}]
			[trait\_values.txt \textsf{\textsl{(text file)}}]
		]
64
	]
Sylvain Jasson's avatar
Sylvain Jasson committed
65
	[my\_name.spell-qtl.log \textsf{\textsl{(text file)}}
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
	]
]
\end{forest}


\begin{itemize}
\item A common working directory must be set for all 3 executables using command line option \texttt{-wd my\_directory} or \texttt{--work-directory my\_directory}. Every result produced during analysis will be directed to this directory.
\item A configuration name using command line option \texttt{-n my\_name} or \texttt{--name my\_name} is used to name subdirectories.
\item Parental Origin Probabilities are output as CSV files
\begin{description}
\item [1-point] one file per marker (with pedigree like structure), use option \texttt{-O1} in command \texttt{spell-marker} to output these files
\item [n-point] one file per linkage group per generation per individual, use model option \texttt{output-nppop} in command \texttt{spell-qtl} to output these files. 
\end{description}
\item a report containing
\begin{itemize}
\item A text-mode file rendering of the genetic map with the detected QTLs and their confidence interval
\item The model matrix ans the variance-covariance matrix for each selection the detection algorithm used
\item The detailed final model including variance-covariance matrix, coefficients, contrasts and contrasts significance
\end{itemize}
\item some hidden files with cached computation results. 
\end{itemize}

\section{Output files samples}
\subsection{1-point POP}
\lstinputlisting[numbers=left,
		frame=single,
Sylvain Jasson's avatar
Sylvain Jasson committed
92
		caption={[1-point output file] 1-point output file (selected lines from file \texttt{my\_name.pedigree-and-probabilities.M\_1\_1.csv}  in directory \texttt{my\_directory/my\_name.1-point/} )  },
93
94
95
		linerange={1-12,107-112}
]{my_directory/my_name.1-point/my_name.pedigree-and-probabilities.M_1_1.csv}

Sylvain Jasson's avatar
Sylvain Jasson committed
96
Note that you must use \texttt{-01} command line option in \texttt{spell-marker} in order to generate these files (see \vref{spell-marker:output-modes}.) 
97
98

\subsection{n-point POP}
Sylvain Jasson's avatar
Sylvain Jasson committed
99
100
101
102
103
104
105
106
107
108
\lstinputlisting[numbers=left,
		frame=single,
		caption={[n-point output file] n-point output file (\texttt{my\_name.ch1.F2.0.csv}  in directory \texttt{my\_directory/my\_name.n-point/ch1/F2/} )  },
]
{output_files/my_name.ch1.F2.0.csv}

Note that you must use \texttt{output-nppop} processing option in \texttt{spell-qtl} in order to generate these files (see \vref{spell-qtl:processing-options}.)

\subsection{full map}

Sylvain Jasson's avatar
Sylvain Jasson committed
109
The special text file named \texttt{full\_map.txt} is produced at the root of \texttt{my name.report} directory. The full genetic map is drawn using text characters. Any detected QTL (for any trait under study) is inserted in this map with its confidence interval (figure \vref{fig:full-map}). 
Sylvain Jasson's avatar
Sylvain Jasson committed
110
111
112

\begin{figure}[h]
\includegraphics[width=1.0\textwidth]{full_map.png}
Sylvain Jasson's avatar
Sylvain Jasson committed
113
\caption{screen capture of \texttt{less -RS full\_map.txt} in a \textit{ad hoc} resized terminal. Chromosome names are printed light blue. The chromosome and markers names are white. The found QTL and its confidence interval are added  in green labeled with trait name (\texttt{t1}), \texttt{@},  QTL position (\texttt{135.34}) and confidence interval (\texttt{[129.246:140.84]})}
Sylvain Jasson's avatar
Sylvain Jasson committed
114
115
116
\label{fig:full-map}
\end{figure}

Sylvain Jasson's avatar
Sylvain Jasson committed
117
Note that you must use  \texttt{cat} or  \texttt{less -RS} command in ordrer to see it properly. \texttt{more} command, \texttt{less} command or your favorite text editor may fail to read special characters. 
Sylvain Jasson's avatar
Sylvain Jasson committed
118
119

\subsection{Trait by trait reports}
Sylvain Jasson's avatar
Sylvain Jasson committed
120
For every trait under analysis, a report directory is generated (this directory name is the trait name). Whithin this directoty the report file itself is named after the trait name followed by \texttt{\_report.txt}
Sylvain Jasson's avatar
Sylvain Jasson committed
121
122
123
124
125

This file is divided in several parts. For the sample file \vref{sample:report} they are :
\begin{description}
\item[General information (lines 1-7)] Trait name and what was detected (QTLs positions and confidence intervals)
\item[R2 (lines 12-20)] Part of the variance explained by each QTL
Sylvain Jasson's avatar
Sylvain Jasson committed
126
127
128
129
\item[Coefficients (lines 22-54)] Cross effects and QTLs allele effects are displayed with their estimated vairiance-covariance matrix
\item[Contrasts (lines 57-79 and 81-103)] Any tractable contrast is computed and its significance tested. \texttt{spell-qtl} displays a contrasts section for every comparable effects group. 
\item[Final Model (lines 105-325)] The final linear model for this detection is then displayed in human readable form. (It is available in computer readable form in files \texttt{trait\_values.txt} and  \texttt{Model\_*X.txt})
\item[Final Model inversion (lines 328-351)] $(X^tX)^{-1}$ matrix from linear model solving in human readable form. (It is available in computer readable form in file \texttt{Model\_*\_XtX\_inv.txt}).
Sylvain Jasson's avatar
Sylvain Jasson committed
130
131
132
133
134
135
136
137
138
139
140
\end{description}

\lstinputlisting[numbers=left,
		frame=single,
		caption={[report file] sample report file (\texttt{t1\_report.txt}  in directory \texttt{my\_directory/my\_name.report/t1} )  },
		label={sample:report}
]
{output_files/t1_report.txt}