From bc8f923881bee342f53a19f0da24615d3df2d481 Mon Sep 17 00:00:00 2001 From: dipterix Date: Wed, 24 Jan 2024 11:03:13 -0500 Subject: [PATCH] updated readme --- README.md | 24 +++++++++++++++++++++++- 1 file changed, 23 insertions(+), 1 deletion(-) diff --git a/README.md b/README.md index 472a69af..f098cb21 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# RAVE: __R__ __A__*nalysis and* __V__*isualization of intracranial* __E__*lectroencephalography* +# RAVE: __R__*reproducible* __A__*nalysis and* __V__*isualization of intracranial* __E__*lectroencephalography* For all RAVE info, including installation instructions, visit https://rave.wiki @@ -9,3 +9,25 @@ For all RAVE info, including installation instructions, visit https://rave.wiki [![R-CMD-check](https://github.com/beauchamplab/rave/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/beauchamplab/rave/actions/workflows/R-CMD-check.yaml) +RAVE contains multiple R & Python packages, pipeline modules, and analysis snippets. + +* [rave-pipelines](https://github.com/dipterix/rave-pipelines): Reproducible pipelines for iEEG preprocessing and data exploration +* [rave-gists](https://github.com/rave-ieeg/rave-gists): Code snippets written for individual labs/researchers + +### Package Builder Status + +All packages are hosted on CRAN and/or r-universe. Please follow [the instructions](https://openwetware.org/wiki/RAVE:Install) to install them. Low-level documentations are available for developers. + +|Source Package|Build Version|Builder Status|Description & Documentation| +|:--|:--|:--|:--| +|[![ravemanager](https://img.shields.io/github/r-package/v/dipterix/ravemanager/master?logo=github&style=flat-square&color=white&label=ravemanager)](https://github.com/dipterix/ravemanager)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/ravemanager?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/ravemanager)|[![R-CMD-check](https://github.com/dipterix/ravemanager/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dipterix/ravemanager/actions/workflows/R-CMD-check.yaml)|[Dependence manager](https://dipterix.org/ravemanager/reference/index.html)| +|[![rave](https://img.shields.io/github/r-package/v/beauchamplab/rave/master?logo=github&style=flat-square&color=white&label=rave)](https://github.com/beauchamplab/rave)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/rave?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/rave)|[![R-CMD-check](https://github.com/beauchamplab/rave/workflows/R-CMD-check/badge.svg)](https://github.com/beauchamplab/rave/actions)|[Main package](https://openwetware.org/wiki/RAVE)| +|[![ravedash](https://img.shields.io/github/r-package/v/dipterix/ravedash/master?logo=github&style=flat-square&color=white&label=ravedash)](https://github.com/dipterix/ravedash)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/ravedash?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/ravedash)|[![R-CMD-check](https://github.com/dipterix/ravedash/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dipterix/ravedash/actions/workflows/R-CMD-check.yaml)|[Front-end dashboard](https://dipterix.org/ravedash/)| +|[![ravetools](https://img.shields.io/github/r-package/v/dipterix/ravetools/master?logo=github&style=flat-square&color=white&label=ravetools)](https://github.com/dipterix/ravetools)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/ravetools?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/ravetools)|[![R-CMD-check](https://github.com/dipterix/ravetools/workflows/R-CMD-check/badge.svg)](https://github.com/dipterix/ravetools/actions)|[Signal processing](https://dipterix.org/ravetools/)| +|[![raveio](https://img.shields.io/github/r-package/v/beauchamplab/raveio/master?logo=github&style=flat-square&color=white&label=raveio)](https://github.com/beauchamplab/raveio)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/raveio?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/raveio)|[![R-CMD-check](https://github.com/beauchamplab/raveio/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/beauchamplab/raveio/actions/workflows/R-CMD-check.yaml)|[File system support](https://beauchamplab.github.io/raveio/reference/index.html)| +|[![filearray](https://img.shields.io/github/r-package/v/dipterix/filearray/master?logo=github&style=flat-square&color=white&label=filearray)](https://github.com/dipterix/filearray)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/filearray?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/filearray)|[![R-check](https://github.com/dipterix/filearray/workflows/R-CMD-check/badge.svg)](https://github.com/dipterix/filearray/actions)|[Out-of-memory analysis](https://dipterix.org/filearray/)| +|[![threeBrain](https://img.shields.io/github/r-package/v/dipterix/threeBrain/master?logo=github&style=flat-square&color=white&label=threeBrain)](https://github.com/dipterix/threeBrain)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/threeBrain?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/threeBrain)|[![R-CMD-check](https://github.com/dipterix/threeBrain/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dipterix/threeBrain/actions/workflows/R-CMD-check.yaml)|[3D viewer engine](https://dipterix.org/threeBrain/)| +|[![rpymat](https://img.shields.io/github/r-package/v/dipterix/rpymat/master?logo=github&style=flat-square&color=white&label=rpymat)](https://github.com/dipterix/rpymat)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/rpymat?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/rpymat)|[![R-CMD-check](https://github.com/dipterix/rpymat/workflows/R-CMD-check/badge.svg)](https://github.com/dipterix/rpymat/actions)|[Python manager & interface](https://dipterix.org/rpymat/)| +|[![rpyANTs](https://img.shields.io/github/r-package/v/dipterix/rpyANTs/master?logo=github&style=flat-square&color=white&label=rpyANTs)](https://github.com/dipterix/rpyANTs)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/rpyANTs?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/rpyANTs)|[![R-CMD-check](https://github.com/dipterix/rpyANTs/workflows/R-CMD-check/badge.svg)](https://github.com/dipterix/rpyANTs/actions)|[Interface to ANTs](https://dipterix.org/rpyANTs/)| +|[![dipsaus](https://img.shields.io/github/r-package/v/dipterix/dipsaus/master?logo=github&style=flat-square&color=white&label=dipsaus)](https://github.com/dipterix/dipsaus)|[![r-universe](https://rave-ieeg.r-universe.dev/badges/dipsaus?color=blue&style=classic)](https://rave-ieeg.r-universe.dev/dipsaus)|[![R-CMD-check](https://github.com/dipterix/dipsaus/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/dipterix/dipsaus/actions/workflows/R-CMD-check.yaml)|[Utility functions](https://dipterix.org/dipsaus/)| +