Skip to content

Commit

Permalink
add a section on the mzQC format in the vignette
Browse files Browse the repository at this point in the history
  • Loading branch information
tnaake committed Aug 9, 2023
1 parent 2b8d992 commit 786ed75
Showing 1 changed file with 17 additions and 0 deletions.
17 changes: 17 additions & 0 deletions vignettes/MsQuality.Rmd
Original file line number Diff line number Diff line change
Expand Up @@ -261,6 +261,8 @@ Currently, the following metrics are included:
qualityMetrics(sps_comb)
```

## List of included metrics

The following list gives a brief explanation for these metrics. Further
information may be found at the
[HUPO-PSI mzQC project page](https://github.com/HUPO-PSI/mzQC) or in the
Expand Down Expand Up @@ -781,6 +783,8 @@ Currently, all quality metrics can be calculated for both `Spectra` and
(3) the median of the precursor charge values is calculated and returned.


## Obtain the metrics in `data.frame`-format

The most important function to assess the data quality and to calculate the
metrics is the `calculateMetrics` function. The function takes
a `Spectra` or `MsExperiment` object as input, a character vector of metrics
Expand Down Expand Up @@ -845,6 +849,19 @@ Alternatively, an `MsExperiment` object might be passed to
to rows in `sampleData(msexp))`) and calculate the quality metrics on the
corresponding `Spectra`s.

## Obtain the metrics in `mzQC`-format

By default, a `data.frame` object containing the metric values as entries
are returned by the the function `calculateMetrics`. Alternatively, the
function also allows the user to export the metrics in a format defined by
the `rmzqc` package by setting the argument `format` to `"mzQC"` (default:
`format = "data.frame"`). In that case, only the metrics that comply to the
`mzQC` specification will be written to the returned object.
The object can be exported and validated using the functionality of the `rmzqc`
package (see the documentation of `rmzqc` for further information).

## Remove empty spectra prior to the calculation

There are in total `r length(msexp_hilic)` samples
respectively in the objects `msexp_rplc` and `msexp_hilic`. To improve
the visualization and interpretability, we will only calculate the metrics
Expand Down

0 comments on commit 786ed75

Please sign in to comment.