spant provides a full suite of tools to build automated analysis pipelines for Magnetic Resonance Spectroscopy (MRS) data. The following features and algorithms are included:
Download and install the latest version of R (https://cloud.r-project.org/), or with your package manager if using a recent Linux distribution, eg sudo apt install r-base
.
It is also strongly recommended to install RStudio Desktop (https://rstudio.com/products/rstudio/download) to provide a modern environment for interactive data analysis.
Once R and RStudio have been installed, open the RStudio application and type the following in the Console (lower left panel) to install the latest stable version of spant:
install.packages("spant", dependencies = TRUE)
Or the the development version from GitHub (requires the devtools
package):
install.packages("devtools")
devtools::install_github("martin3141/spant", ref = "devel")
Quick introduction to the basic analysis workflow : https://martin3141.github.io/spant/articles/spant-intro.html
Short tutorials : https://martin3141.github.io/spant/articles/
Function reference : https://martin3141.github.io/spant/reference/
Once the spant library has been loaded with library(spant)
, type ?spant
on the console for instructions on how to access the offline documentation. Note that offline help on the available functions can be quickly shown in RStudio using ?function_name
, eg ?read_mrs
.