root / doc / sphinx_doc / readme.rst @ a0b91fee
Historique | Voir | Annoter | Télécharger (3,9 ko)
| 1 |
***************************************** |
|---|---|
| 2 |
Readme / Documentation for `NucleoMiner2` |
| 3 |
***************************************** |
| 4 |
|
| 5 |
`NucleoMiner2` offers Python API and R package allowing to perform |
| 6 |
quantitative analysis of nucleosomal epigenome. It is especially well |
| 7 |
suited for scripting to extract natural Single-Nucleosome Epi- |
| 8 |
Polymorphisms (SNEP) from ChIP-Seq data. |
| 9 |
|
| 10 |
License |
| 11 |
======= |
| 12 |
|
| 13 |
Copyright CNRS 2012-2013 |
| 14 |
|
| 15 |
- Florent CHUFFART |
| 16 |
- Jean-Baptiste VEYRIERAS |
| 17 |
- Gael YVERT |
| 18 |
|
| 19 |
This software is a computer program which purpose is to perform quanti- |
| 20 |
tative analysis of epigenetic marks at single nucleosome resolution. |
| 21 |
|
| 22 |
This software is governed by the CeCILL license under French law and |
| 23 |
abiding by the rules of distribution of free software. You can use, |
| 24 |
modify and/ or redistribute the software under the terms of the CeCILL |
| 25 |
license as circulated by CEA, CNRS and INRIA at the following URL |
| 26 |
"http://www.cecill.info". |
| 27 |
|
| 28 |
As a counterpart to the access to the source code and rights to copy, |
| 29 |
modify and redistribute granted by the license, users are provided only |
| 30 |
with a limited warranty and the software's author, the holder of the |
| 31 |
economic rights, and the successive licensors have only limited |
| 32 |
liability. |
| 33 |
|
| 34 |
In this respect, the user's attention is drawn to the risks associated |
| 35 |
with loading, using, modifying and/or developing or reproducing the |
| 36 |
software by the user in light of its specific status of free software, |
| 37 |
that may mean that it is complicated to manipulate, and that also |
| 38 |
therefore means that it is reserved for developers and experienced |
| 39 |
professionals having in-depth computer knowledge. Users are therefore |
| 40 |
encouraged to load and test the software's suitability as regards their |
| 41 |
requirements in conditions enabling the security of their systems and/or |
| 42 |
data to be ensured and, more generally, to use and operate it in the |
| 43 |
same conditions as regards security. |
| 44 |
|
| 45 |
The fact that you are presently reading this means that you have had |
| 46 |
knowledge of the CeCILL license and that you accept its terms. |
| 47 |
|
| 48 |
Installation Instructions |
| 49 |
========================= |
| 50 |
|
| 51 |
Links |
| 52 |
----- |
| 53 |
|
| 54 |
`NucleoMiner2` home page and documentation: https://forge.cbp.ens-lyon.fr/redmine/projects/nucleominer |
| 55 |
|
| 56 |
Gael Yvert lab page: http://www.ens-lyon.fr/LBMC/gisv/ |
| 57 |
|
| 58 |
|
| 59 |
Installation |
| 60 |
------------ |
| 61 |
|
| 62 |
- Download archive |
| 63 |
- Compile bowtie2 |
| 64 |
- Compile samtools |
| 65 |
- Compile bedtools |
| 66 |
- Compile TemplateFilter |
| 67 |
|
| 68 |
Required R pacakes: |
| 69 |
- bot |
| 70 |
- fork |
| 71 |
- rjson |
| 72 |
- seqinr |
| 73 |
|
| 74 |
.. code:: bash |
| 75 |
|
| 76 |
cd src/r_packages/ |
| 77 |
tar xfvz R-latest.tar.gz |
| 78 |
cd R-patched |
| 79 |
./configure --with-x=no PDFLATEX="ls" |
| 80 |
make |
| 81 |
cd ../../.. |
| 82 |
R_BIN=src/r_packages/R-patched/bin/R |
| 83 |
$R_BIN CMD INSTALL src/r_packages/rjson_0.2.12.tar.gz |
| 84 |
$R_BIN CMD INSTALL src/r_packages/seqinr_3.0-7.tar.gz |
| 85 |
$R_BIN CMD INSTALL src/r_packages/plotrix_3.4-5.tar.gz |
| 86 |
$R_BIN CMD INSTALL src/r_packages/nm_2.0.tar.gz |
| 87 |
$R_BIN CMD INSTALL src/r_packages/fork_1.2.4.tar.gz |
| 88 |
$R_BIN CMD INSTALL src/r_packages/bot_0.9.tar.gz |
| 89 |
$R_BIN CMD INSTALL src/r_packages/DESeq_1.14.0.tar.gz |
| 90 |
|
| 91 |
|
| 92 |
... |
| 93 |
|
| 94 |
usage |
| 95 |
===== |
| 96 |
|
| 97 |
See html documentation for `NucleoMiner2`: http://www.ens-lyon.fr/LBMC/gisv/ |