Commit 0a2f46ea authored by Etienne Rifa's avatar Etienne Rifa
Browse files

document

parent 30ed64b2
......@@ -7,3 +7,4 @@ $run_dev.*
^LICENSE\.md$
^README\.Rmd$
^CODE_OF_CONDUCT\.md$
^Dockerfile$
......@@ -5,3 +5,5 @@
README.Rmd
data_test/
.dockerignore
Dockerfile
\ No newline at end of file
......@@ -40,4 +40,4 @@ Config/testthat/edition: 3
Encoding: UTF-8
Language: en-US
LazyData: true
RoxygenNote: 7.1.2
RoxygenNote: 7.2.0
---
output: github_document
---
<!-- README.md is generated from README.Rmd. Please edit that file -->
```{r, include = FALSE}
knitr::opts_chunk$set(
collapse = TRUE,
comment = "#>",
fig.path = "man/figures/README-",
out.width = "100%"
)
```
# graphstats
<!-- badges: start -->
<!-- [![Lifecycle: experimental](https://img.shields.io/badge/lifecycle-experimental-orange.svg)](https://lifecycle.r-lib.org/articles/stages.html#experimental) -->
<!-- badges: end -->
## Installation
You can install the released version of graphstats from [this repository](https://forgemia.inra.fr/etienne.rifa/graphstats) with:
``` {r install, eval = FALSE}
install.packages("remotes")
remotes::install_gitlab(repo = "etienne.rifa/graphstats", auth_token = 'LgkWC8oPN7aq8bXZ8Cto', host = "forgemia.inra.fr")
```
## To run Shiny app
```{r run, eval = FALSE}
library(graphstats)
graphstats::run_app()
```
......@@ -49,3 +49,14 @@ remotes::install_gitlab(repo = "etienne.rifa/graphstats", host = "forgemia.inra.
library(graphstatsr)
graphstatsr::run_app()
```
## 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") )
# [1] "features_quanti_data.csv" "metadata_file.csv"
```
Supports Markdown
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment