Skip to content
Snippets Groups Projects
README.md 1.56 KiB
Newer Older
Etienne Rifa's avatar
Etienne Rifa committed

<!-- README.md is generated from README.Rmd. Please edit that file -->

Etienne Rifa's avatar
Etienne Rifa committed
# GraphstatsR <a href="https://forgemia.inra.fr/etienne.rifa/graphstats"><img src="man/figures/graphstatsr_150px.png" alt="ispickr" align="right" width="150" style="margin-top: 10px; margin-left: 20px;"/></a>
Etienne Rifa's avatar
Etienne Rifa committed

<!-- badges: start -->
Etienne Rifa's avatar
Etienne Rifa committed
<!-- [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) -->
Etienne Rifa's avatar
Etienne Rifa committed
<!-- badges: end -->

Etienne Rifa's avatar
Etienne Rifa committed
A shiny app allowing users to generate advanced interactive graphics and statistical tests. 

Etienne Rifa's avatar
Etienne Rifa committed
Online instance here: https://graphstatsr.sk8.inrae.fr/
Etienne Rifa's avatar
Etienne Rifa committed

## Prerequisites

Etienne Rifa's avatar
Etienne Rifa committed
R4.4.2 or upper is required (https://pbil.univ-lyon1.fr/CRAN/bin/)
Etienne Rifa's avatar
Etienne Rifa committed


* Linux

```bash
Etienne Rifa's avatar
Etienne Rifa committed
sudo apt-get install r-base git libssl-dev cmake libcurl4-openssl-dev libgmp3-dev libmpfr-dev zlib1g-dev
Etienne Rifa's avatar
Etienne Rifa committed
```

* Windows

[Rtools](https://cran.r-project.org/bin/windows/Rtools/) and [git](https://git-scm.com/download/win) are required.


Etienne Rifa's avatar
Etienne Rifa committed
## Installation

Etienne Rifa's avatar
Etienne Rifa committed
* In R console: 
Etienne Rifa's avatar
Etienne Rifa committed
You can install the released version of graphstats from [this
repository](https://forgemia.inra.fr/etienne.rifa/graphstats) with:
Etienne Rifa's avatar
Etienne Rifa committed

``` r
Etienne Rifa's avatar
Etienne Rifa committed
install.packages("renv")
options(renv.config.gitlab.host = "https://forgemia.inra.fr")

renv::install("gitlab::etienne.rifa/graphstats@master")

Etienne Rifa's avatar
Etienne Rifa committed
```

Etienne Rifa's avatar
Etienne Rifa committed
## To run Shiny app in R
Etienne Rifa's avatar
Etienne Rifa committed

``` r
Etienne Rifa's avatar
Etienne Rifa committed
library(graphstatsr)
Etienne Rifa's avatar
Etienne Rifa committed
graphstatsr::run_app()
Etienne Rifa's avatar
Etienne Rifa committed
```
Etienne Rifa's avatar
Etienne Rifa committed

## Toy dataset

Features table and metadata files are available in the `dataset` folder to test Graphstats. (`inst/dataset` in the git repo)

```r
dir( system.file("dataset/", package = "graphstatsr") )
```