index.html 10.5 KB
Newer Older
Romain Feron's avatar
Romain Feron committed
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19


<!DOCTYPE html>
<!--[if IE 8]><html class="no-js lt-ie9" lang="en" > <![endif]-->
<!--[if gt IE 8]><!--> <html class="no-js" lang="en" > <!--<![endif]-->
<head>
  <meta charset="utf-8">
  
  <meta name="viewport" content="width=device-width, initial-scale=1.0">
  
  <title>RADSex documentation &mdash; RADSex 0.1.0 documentation</title>
  

  
  
  
  

  
RomainFeron's avatar
RomainFeron committed
20
  <script type="text/javascript" src="_static/js/modernizr.min.js"></script>
Romain Feron's avatar
Romain Feron committed
21
22
  
    
RomainFeron's avatar
RomainFeron committed
23
24
25
26
27
28
29
      <script type="text/javascript" id="documentation_options" data-url_root="./" src="_static/documentation_options.js"></script>
        <script src="_static/jquery.js"></script>
        <script src="_static/underscore.js"></script>
        <script src="_static/doctools.js"></script>
        <script src="_static/language_data.js"></script>
    
    <script type="text/javascript" src="_static/js/theme.js"></script>
Romain Feron's avatar
Romain Feron committed
30

RomainFeron's avatar
RomainFeron committed
31
    
Romain Feron's avatar
Romain Feron committed
32

RomainFeron's avatar
RomainFeron committed
33
  
Romain Feron's avatar
Romain Feron committed
34
35
36
37
38
39
40
41
42
43
44
45
46
47
  <link rel="stylesheet" href="_static/css/theme.css" type="text/css" />
  <link rel="stylesheet" href="_static/pygments.css" type="text/css" />
    <link rel="index" title="Index" href="genindex.html" />
    <link rel="search" title="Search" href="search.html" />
    <link rel="next" title="Getting started" href="getting_started.html" /> 
</head>

<body class="wy-body-for-nav">

   
  <div class="wy-grid-for-nav">
    
    <nav data-toggle="wy-nav-shift" class="wy-nav-side">
      <div class="wy-side-scroll">
RomainFeron's avatar
RomainFeron committed
48
        <div class="wy-side-nav-search" >
Romain Feron's avatar
Romain Feron committed
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
          

          
            <a href="#" class="icon icon-home"> RADSex
          

          
          </a>

          
            
            
              <div class="version">
                0.1
              </div>
            
          

          
<div role="search">
  <form id="rtd-search-form" class="wy-form" action="search.html" method="get">
    <input type="text" name="q" placeholder="Search docs" />
    <input type="hidden" name="check_keywords" value="yes" />
    <input type="hidden" name="area" value="default" />
  </form>
</div>

          
        </div>

        <div class="wy-menu wy-menu-vertical" data-spy="affix" role="navigation" aria-label="main navigation">
          
            
            
              
            
            
              <ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a></li>
<li class="toctree-l1"><a class="reference internal" href="example.html">Example walkthrough</a></li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">RADSex usage</a></li>
<li class="toctree-l1"><a class="reference internal" href="input_files.html">Input files</a></li>
<li class="toctree-l1"><a class="reference internal" href="output_files.html">Output files</a></li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>

            
          
        </div>
      </div>
    </nav>

    <section data-toggle="wy-nav-shift" class="wy-nav-content-wrap">

      
      <nav class="wy-nav-top" aria-label="top navigation">
        
          <i data-toggle="wy-nav-top" class="fa fa-bars"></i>
          <a href="#">RADSex</a>
        
      </nav>


      <div class="wy-nav-content">
        
        <div class="rst-content">
        
          















<div role="navigation" aria-label="breadcrumbs navigation">

  <ul class="wy-breadcrumbs">
    
      <li><a href="#">Docs</a> &raquo;</li>
        
      <li>RADSex documentation</li>
    
    
      <li class="wy-breadcrumbs-aside">
        
            
            <a href="_sources/index.rst.txt" rel="nofollow"> View page source</a>
          
        
      </li>
    
  </ul>

  
  <hr/>
</div>
          <div role="main" class="document" itemscope="itemscope" itemtype="http://schema.org/Article">
           <div itemprop="articleBody">
            
  <div class="section" id="radsex-documentation">
<h1>RADSex documentation<a class="headerlink" href="#radsex-documentation" title="Permalink to this headline"></a></h1>
<p>RADSex is a software package to analyze RAD-Sequencing data. It is primarily designed to look compare female and male populations looking for sex signal, but it can be used to compare any two populations.</p>
<p>The core idea of RADSex is to compare presence / absence of non-polymorphic markers between individuals in two populations. RADSex does not allow mismatches when grouping reads into markers. This means that each allele in a polyallelic locus is represented as a separate marker, whereas other RAD-Sequencing analysis softwares would usually group these alleles in a single polymorphic marker. Separating alleles from polymorphic markers enables RADSex to easily detect sex-specific alleles, using only minimum depth of a marker as a parameter.</p>
<p>The main input of RADSex is a dataset of demultiplexed RAD reads, <em>i.e.</em> one reads file per individual. From this dataset, RADSex generates a table containing the depth of each marker in each individual. This table is then used to infer information about the type of sex-determination system, identify sex-biased markers, or align the markers to a reference genome. Several functions are also implemented to assist with general analysis of the dataset, for instance computing the frequencies of markers in individuals from the dataset or the median marker depth in each individual.</p>
<p>Results from RADSex can be visualized with the <a class="reference external" href="https://github.com/INRA-LPGP/radsex-vis">radsex-vis</a> R package. This R package provides easy-to-use functions to generate visual representations of your data.</p>
<p>RADSex’s API documentation generated with Doxygen is available <a class="reference external" href="doxygen/index.html">here</a></p>
<div class="section" id="documentation-summary">
<h2>Documentation summary<a class="headerlink" href="#documentation-summary" title="Permalink to this headline"></a></h2>
<div class="toctree-wrapper compound">
<ul>
<li class="toctree-l1"><a class="reference internal" href="getting_started.html">Getting started</a><ul>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#installation">Installation</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#before-starting">Before starting</a></li>
<li class="toctree-l2"><a class="reference internal" href="getting_started.html#running-radsex">Running RADSex</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="example.html">Example walkthrough</a><ul>
<li class="toctree-l2"><a class="reference internal" href="example.html#preparing-the-data">Preparing the data</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html#generating-a-table-of-marker-depths-for-the-entire-dataset">Generating a table of marker depths for the entire dataset</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html#computing-the-distribution-of-markers-between-sexes">Computing the distribution of markers between sexes</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html#finding-markers-significantly-associated-with-sex">Finding markers significantly associated with sex</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html#aligning-markers-to-a-genome">Aligning markers to a genome</a></li>
<li class="toctree-l2"><a class="reference internal" href="example.html#going-further">Going further</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="usage.html">RADSex usage</a><ul>
<li class="toctree-l2"><a class="reference internal" href="usage.html#process">process</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#distrib">distrib</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#signif">signif</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#map">map</a></li>
RomainFeron's avatar
RomainFeron committed
188
<li class="toctree-l2"><a class="reference internal" href="usage.html#subset">subset</a></li>
Romain Feron's avatar
Romain Feron committed
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
<li class="toctree-l2"><a class="reference internal" href="usage.html#freq">freq</a></li>
<li class="toctree-l2"><a class="reference internal" href="usage.html#depth">depth</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="input_files.html">Input files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="input_files.html#reads-files">Reads files</a></li>
<li class="toctree-l2"><a class="reference internal" href="input_files.html#population-map">Population map</a></li>
<li class="toctree-l2"><a class="reference internal" href="input_files.html#chromosomes-names-file">Chromosomes names file</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="output_files.html">Output files</a><ul>
<li class="toctree-l2"><a class="reference internal" href="output_files.html#markers-depth-table">Markers depth table</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_files.html#distribution-of-markers-between-groups">Distribution of markers between groups</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_files.html#fasta-file">Fasta file</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_files.html#alignment-results">Alignment results</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_files.html#distribution-of-markers-in-the-population">Distribution of markers in the population</a></li>
<li class="toctree-l2"><a class="reference internal" href="output_files.html#distribution-of-marker-depth-in-each-individual">Distribution of marker depth in each individual</a></li>
</ul>
</li>
<li class="toctree-l1"><a class="reference internal" href="license.html">License</a></li>
</ul>
</div>
</div>
</div>


           </div>
           
          </div>
          <footer>
  
    <div class="rst-footer-buttons" role="navigation" aria-label="footer navigation">
      
        <a href="getting_started.html" class="btn btn-neutral float-right" title="Getting started" accesskey="n" rel="next">Next <span class="fa fa-arrow-circle-right"></span></a>
      
      
    </div>
  

  <hr/>

  <div role="contentinfo">
    <p>
        &copy; Copyright 2018-2020, Romain Feron

    </p>
  </div>
  Built with <a href="http://sphinx-doc.org/">Sphinx</a> using a <a href="https://github.com/rtfd/sphinx_rtd_theme">theme</a> provided by <a href="https://readthedocs.org">Read the Docs</a>. 

</footer>

        </div>
      </div>

    </section>

  </div>
  


  <script type="text/javascript">
      jQuery(function () {
          SphinxRtdTheme.Navigation.enable(true);
      });
RomainFeron's avatar
RomainFeron committed
253
254
255
256
257
258
  </script>

  
  
    
   
Romain Feron's avatar
Romain Feron committed
259
260
261

</body>
</html>