Révision e5603c3f README

b/README
3 3
*****************************************
4 4

  
5 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.
6
quantitative analysis of epigenetic marks on individual nucleosomes.
7
It was developed to detect natural Single-Nucleosome Epi-Polymorphisms
8
(SNEP) from MNase-seq and ChIP-seq data.
9 9

  
10 10

  
11 11
License
......
35 35
of the economic rights,  and the successive licensors  have only
36 36
limited liability.
37 37

  
38
In this respect, the user's attention is drawn to the risks associated
39
with loading,  using,  modifying and/or developing or reproducing the
40
software by the user in light of its specific status of free software,
41
that may mean  that it is complicated to manipulate,  and  that  also
42
therefore means  that it is reserved for developers  and  experienced
43
professionals having in-depth computer knowledge. Users are therefore
44
encouraged to load and test the software's suitability as regards
45
their requirements in conditions enabling the security of their
46
systems and/or data to be ensured and,  more generally, to use and
47
operate it in the same conditions as regards security.
38
This software is provided with absolutely NO WARRANTY. The authors can
39
not be held responsible, even partially, for any damage, loss,
40
financial loss or any other undesired facts resulting from the use of
41
the software. In this respect, the user's attention is drawn to the
42
risks associated with loading,  using,  modifying and/or developing or
43
reproducing the software by the user in light of its specific status
44
of free software, that may mean  that it is complicated to manipulate,
45
and  that  also therefore means  that it is reserved for developers
46
and  experienced professionals having in-depth computer knowledge.
47
Users are therefore encouraged to load and test the software's
48
suitability as regards their requirements in conditions enabling the
49
security of their systems and/or data to be ensured and,  more
50
generally, to use and operate it in the same conditions as regards
51
security.
48 52

  
49 53
The fact that you are presently reading this means that you have had
50 54
knowledge of the CeCILL license and that you accept its terms.
......
57 61
Links
58 62
-----
59 63

  
60
*NucleoMiner2* home page and documentation: https://forge.cbp.ens-
61
lyon.fr/redmine/projects/nucleominer
64
*NucleoMiner2* home page and documentation are available here:
62 65

  
63
Gael Yvert lab page: http://www.ens-lyon.fr/LBMC/gisv/
66
   * https://forge.cbp.ens-lyon.fr/redmine/projects/nucleominer
67

  
68
The Yvert lab web page is accessible here:
69

  
70
   * http://www.ens-lyon.fr/LBMC/gisv/
64 71

  
65 72

  
66 73
Installation
67 74
------------
68 75

  
69
   * Download archive
70 76

  
71
   * Compile bowtie2
77
Prerequisites
78
~~~~~~~~~~~~~
79

  
80
To work properly, NucleoMiner2 needs that the following free software
81
are installed and made available on your system:
82

  
83
   * Bowtie2 http://bowtie-bio.sourceforge.net/bowtie2
72 84

  
73
   * Compile samtools
85
   * SAMtools http://samtools.sourceforge.net
74 86

  
75
   * Compile bedtools
87
   * bedtools http://code.google.com/p/bedtools/
76 88

  
77
   * Compile TemplateFilter
89
   * TemplateFilter
90
     http://compbio.cs.huji.ac.il/NucPosition/TemplateFiltering
78 91

  
79
Required R packages:
80
   * bot
92
It also requires the following R packages to be installed on your
93
system:
81 94

  
82 95
   * fork
83 96

  
......
85 98

  
86 99
   * seqinr
87 100

  
88
   * cachecache
89

  
90
   cd src/r_packages/
91
         tar xfvz R-latest.tar.gz
92
         cd R-patched
93
         ./configure --with-x=no PDFLATEX="ls"
94
         make
95
   cd ../../..
96
   R_BIN=src/r_packages/R-patched/bin/R
97
         $R_BIN CMD INSTALL src/r_packages/rjson_0.2.12.tar.gz
98
         $R_BIN CMD INSTALL src/r_packages/seqinr_3.0-7.tar.gz
99
         $R_BIN CMD INSTALL src/r_packages/plotrix_3.4-5.tar.gz
100
         $R_BIN CMD INSTALL src/r_packages/nm_2.0.tar.gz
101
         $R_BIN CMD INSTALL src/r_packages/fork_1.2.4.tar.gz
102
         $R_BIN CMD INSTALL src/r_packages/bot_0.9.tar.gz
103
         $R_BIN CMD INSTALL src/r_packages/DESeq_1.14.0.tar.gz
104

  
105
...
106

  
101
   * cachecache https://forge.cbp.ens-
102
     lyon.fr/redmine/projects/cachecache
107 103

  
108
usage
109
=====
104
   * bot https://forge.cbp.ens-lyon.fr/redmine/projects/bot
110 105

  
111
See html documentation for *NucleoMiner2*: http://www.ens-
112
lyon.fr/LBMC/gisv/
106
   * nucleominer https://forge.cbp.ens-
107
     lyon.fr/redmine/projects/nucleominer

Formats disponibles : Unified diff