Maintenance - Mise à jour mensuelle Lundi 7 Décembre 2021 entre 7h00 et 9h00

README.md 1.42 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
```r
Aurelien Brionne's avatar
Aurelien Brionne committed
12
## using install_gitlab
13
remotes::install_gitlab(
Aurelien Brionne's avatar
Aurelien Brionne committed
14
15
16
    "aurelien.brionne/GenomeFeatures",
    host = "forgemia.inra.fr",
    build_opts = c("--no-resave-data", "--no-manual")
Aurelien Brionne's avatar
update    
Aurelien Brionne committed
17
)
Aurelien Brionne's avatar
Aurelien Brionne committed
18
19
20
21
22
23
24
25
26

## alternative (from local directory)
    # clone package (from prompt)
    git clone https://forgemia.inra.fr/aurelien.brionne/GenomeFeatures.git

    # build package (from R console) 
    devtools::build("GenomeFeatures")

    # install package (from R console)
Aurelien Brionne's avatar
Aurelien Brionne committed
27
    install.packages("GenomeFeatures_1.1.tar.gz", repos = NULL, type = "source")
28
```
Aurelien Brionne's avatar
Aurelien Brionne committed
29

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
30
## Quick overview
Aurelien Brionne's avatar
Aurelien Brionne committed
31

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

Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
34
35
36
37
38
39
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
40
![](./inst/extdata/barplot.png)
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
41

Aurelien Brionne's avatar
Aurelien Brionne committed
42
![](./inst/extdata/lineplot.png)
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
43
44
45

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

Aurelien Brionne's avatar
Aurelien Brionne committed
46
![](./inst/extdata/table.png)
Aurelien Brionne's avatar
readme    
Aurelien Brionne committed
47
48
49

6. Features ovelaps.

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