Skip to content

Commit

Permalink
Rewrite the tutorial based on Phili's comments
Browse files Browse the repository at this point in the history
  • Loading branch information
jorainer committed Sep 15, 2023
1 parent 53eb0d2 commit 005a08b
Show file tree
Hide file tree
Showing 10 changed files with 1,108 additions and 758 deletions.
8 changes: 6 additions & 2 deletions DESCRIPTION
Original file line number Diff line number Diff line change
@@ -1,11 +1,15 @@
Package: xcmsTutorials
Title: Exploring and Analyzing LC-MS data with Spectra and xcms
Version: 0.1.0
Version: 0.2.0
Authors@R: c(
person(given = "Johannes", family = "Rainer",
email = "[email protected]",
role = c("aut", "cre"),
comment = c(ORCID = "0000-0002-6977-7147")))
comment = c(ORCID = "0000-0002-6977-7147")),
person(given = "Philippine", family = "Louail",
email = "[email protected]",
role = c("ctb")),
comment = c(ORCID = "0009-0007-5429-6846"))
Description: This resource contains examples and tutorials for the analysis of
LC-MS data using the *MsExperiment*, *Spectra* and *xcms* packages.
Various examples show data handling, representation, visualization
Expand Down
8 changes: 8 additions & 0 deletions NEWS.md
Original file line number Diff line number Diff line change
@@ -1 +1,9 @@
# xcmsTutorials 0.2

## Changes in xcmsTutorials 0.2.0

- Rewrite parts of the tutorial based on feedback and corrections provided from
Philippine Louail.


# xcmsTutorials 0.1
54 changes: 24 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ conference 2018 in Seattle (http://metabolomics2018.org).
Covered topics are:
- Data import and representation.
- Accessing, subsetting and visualizing data.
- Centroiding of profile MS data.
- Centroiding of profile mode MS data.
- Chromatographic peak detection.
- Empirically determine appropriate settings for the analyzed data set.
- Evaluation of identified peaks.
Expand All @@ -33,46 +33,40 @@ provided in the [xcms-preprocessing.Rmd](./xcms-preprocessing.Rmd) file. This
file can be opened with e.g. RStudio which allows execution of the individual R
commands (see section below for additionally required R packages). The R command
`rmarkdown::render("xcms-preprocessing.Rmd")` would generate the html file
[xcms-preprocessing.html](https://jorainer.github.io/metabolomics2018/xcms-preprocessing.html).
[xcms-preprocessing.html](https://jorainer.github.io/xcmsTutorials/xcms-preprocessing.html).


## Installation

The analysis in this document requires an R version >= 4.3.0 and recent versions
of the `MsExperiment`, `Spectra` and in particular the `xcms` (version >= 3.99.0
is needed) packages.
For on-line code evaluation, the workshop can also be run using a self-contained
docker image with all R packages and a server version of RStudio (Posit)
pre-installed:

- Get the [docker image](https://hub.docker.com/r/jorainer/xcms_tutorials) of
this tutorial with `docker pull jorainer/xcms_tutorials:latest`.
- Start docker using
```
docker run \
-e PASSWORD=bioc \
-p 8787:8787 \
jorainer/xcms_tutorials:latest
```
- Enter `http://localhost:8787` in a web browser and log in with username
`rstudio` and password `bioc`.
- In the RStudio server version: open any of the R-markdown (*.Rmd*) files in
the *vignettes* folder and evaluate the R code blocks.


For manual installation, an R version >= 4.3.0 is required as well as recent
versions of the packages `MsExperiment`, `Spectra` and in particular the `xcms`
(version >= 3.99.0 is needed). These can be installed using the code below:

```r
install.packages("BiocManager")
BiocManager::install("jorainer/xcmsTutorials",
dependencies = TRUE, ask = FALSE, update = TRUE)
```

Alternatively, the individual packages used in this tutorial can be installed
using the code below.

```r
#' Install the Bioconductor package manager
install.packages("BiocManager")

#' Install the required packages
BiocManager::install(c("msdata",
"Spectra",
"MsExperiment",
"MetaboCoreUtils",
"MsCoreUtils",
"png"))
BiocManager::install("sneumann/xcms")
```

The source code for this document along with the test data can be downloaded
from the github repository https://github.com/jorainer/xcmsTutorials
with the command (or alternatively downloading the zip archive directly from the
github page).

```
git clone https://github.com/jorainer/xcmsTutorials
```


## Additional documentation resources and tutorials
Expand Down
Binary file added vignettes/images/LCMS-data-peaks.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
File renamed without changes
File renamed without changes
Binary file added vignettes/images/alignment.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vignettes/images/correspondence2_03.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added vignettes/images/correspondence2_density.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading

0 comments on commit 005a08b

Please sign in to comment.