README.md 2.01 KB
Newer Older
Gosset Simon's avatar
Gosset Simon committed
1
2
3
4
5
6
# appinetwork
An R package for constructing and Analysing of Protein-Protein Interactions (PPI) NETWORKs for complexes and biological processes


## Installation

Gosset Simon's avatar
Gosset Simon committed
7
If you are on a **linux** os, We assume that R, Python version 2.7 and C are installed, prior to any attempt to install the package appinetwork. 
Gosset Simon's avatar
Gosset Simon committed
8
9
10
11
12
13

To install this package from git, you need the devtools package using the following command in R :

    install.packages("devtools")
    library("devtools")
    
Gosset Simon's avatar
Gosset Simon committed
14
15
16
17
You also need the to install the following packages :

    install.packages( pkgs = c("R.methodsS3","rPython","stringr","rlang", "igraph"), dependencies = TRUE)

Gosset Simon's avatar
Gosset Simon committed
18
Now you can install our package from Gitlab using the following command in R :
Gosset Simon's avatar
Gosset Simon committed
19

Gosset Simon's avatar
Gosset Simon committed
20
    devtools::install_gitlab("GNet/appinetwork", host = "https://forgemia.inra.fr")
Gosset Simon's avatar
Gosset Simon committed
21
22
23


    
Gosset Simon's avatar
Gosset Simon committed
24
25
Installation on **Windows** and **MacOs** might be more difficult.

Gosset Simon's avatar
Gosset Simon committed
26
If you are on **windows**, you'll need to install R, python 2.7 (make sure to tick the **"add python to path"** option when you install it) and [Rtools](https://cran.r-project.org/bin/windows/Rtools/rtools40.html) (the link is for R4.0 and up, for prior R version go to this [link](https://cran.r-project.org/bin/windows/Rtools/history.html)).
Gosset Simon's avatar
Gosset Simon committed
27
Then open Rstudio and enter the following commands : 
Gosset Simon's avatar
Gosset Simon committed
28
29
30
    
    install.packages("devtools")
    library("devtools")
Gosset Simon's avatar
Gosset Simon committed
31
    install.packages( pkgs = c("R.methodsS3","rPython","stringr","rlang", "igraph"), dependencies = TRUE, ask = FALSE)
Gosset Simon's avatar
Gosset Simon committed
32
    devtools::install_gitlab("GNet/appinetwork", host = "https://forgemia.inra.fr")
Gosset Simon's avatar
Gosset Simon committed
33

Gosset Simon's avatar
Gosset Simon committed
34
## Usage
Gosset Simon's avatar
Gosset Simon committed
35
36
Load the package with :
`library("appinetwork")`
Gosset Simon's avatar
Gosset Simon committed
37
This package implements a function `interface()` which enables to format PPI databses and performs two mains analysis : model complexes assembly intermediaries and cluster PPI networks. The step by step procedure is described in the [userguide](https://forgemia.inra.fr/GNet/appinetwork/-/blob/master/userguide_appinetwork.pdf).
Gosset Simon's avatar
Gosset Simon committed
38

Gosset Simon's avatar
Gosset Simon committed
39
## For more information : read the [userguide](https://forgemia.inra.fr/GNet/appinetwork/-/blob/master/userguide_appinetwork.pdf)
40