RAPPEL : Opération de maintenance > ForgeMIA indisponible le 20 Janvier entre 7h et 12h

README.md 1.06 KB
Newer Older
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
1
2
3
<img src="./inst/extdata/univ.png" align="right"/>
<img src="./inst/extdata/boa.png" align="right"/>
<img src="./inst/extdata/inra.png" align="right"/>
Aurelien Brionne's avatar
Aurelien Brionne committed
4

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
5
# GenomeFeatures R package
Aurelien Brionne's avatar
Aurelien Brionne committed
6

Aurelien Brionne's avatar
Aurelien Brionne committed
7
The aim of this package is to provide a full genomic features annotation from genomic coordinates, without use an annotation priority.
Aurelien Brionne's avatar
Aurelien Brionne committed
8

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
9
## Installation
Aurelien Brionne's avatar
Aurelien Brionne committed
10

11
12
```r
remotes::install_gitlab(
Aurelien Brionne's avatar
Aurelien Brionne committed
13
  "aurelien.brionne/GenomeFeatures",
14
15
16
17
  host = "forgemia.inra.fr",
  build_opts = c("--no-resave-data", "--no-manual")
)  
```
Aurelien Brionne's avatar
Aurelien Brionne committed
18

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
19
## Quick overview
Aurelien Brionne's avatar
Aurelien Brionne committed
20

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
21
1. load peaks file: `GenomeFeatures::readPeakFile`.
Aurelien Brionne's avatar
Aurelien Brionne committed
22

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
23
24
25
26
27
28
2. Build a convenient object for find overlaps beetween all selected features and genomic coordinates targets: `GenomeFeatures::build_genome_features`.

3. Find overlaps beetween genomic coordinates and features: `GenomeFeatures::genome_features_overlaps`.

4. Features plot: `GenomeFeatures::Plot`.

Aurelien Brionne's avatar
Aurelien Brionne committed
29
![](./inst/extdata/barplot.png)
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
30

Aurelien Brionne's avatar
Aurelien Brionne committed
31
![](./inst/extdata/lineplot.png)
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
32
33
34

5. Get annotation table: `GenomeFeatures::Table`.

Aurelien Brionne's avatar
Aurelien Brionne committed
35
![](./inst/extdata/table.png)
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
36
37
38

6. Features ovelaps.

Aurelien Brionne's avatar
Aurelien Brionne committed
39
![](./inst/extdata/data/output/upset_H3K4Me3_J35.png)