Author: Chris Bielow chris.bielow@fu-berlin.de
Date: 2025-07-15

# Using a custom controlled vocabulary for rMZQC

#### Chris Bielow chris.bielow@fu-berlin.de

#### 2025-07-15

# Using a custom controlled vocabulary for rMZQC

This vignette serves as a guide for R users to use a custom CV before creating an mzQC document.

Warning: you should settle on a CV before instantiating any mzQC objects, since this ensures that all CV terms are consistent (and checked for existance) and that the CV meta information within the mzQC document is accurate.

Target Audience: R users

## Create a minial mzQC document with a custom CV

Let’s first consider what happens by default:

    library(rmzqc)

    print(getCVInfo())

    ## <MzQCcontrolledVocabulary>
    ##   Public:
    ##     clone: function (deep = FALSE)
    ##     fromData: function (data, context = "MzQCcontrolledVocabulary")
    ##     initialize: function (name = NA_character_, uri = NA_character_, version = NA_character_)
    ##     isValid: function (context = "MzQCcontrolledVocabulary")
    ##     name: Proteomics Standards Initiative Mass Spectrometry Ontology
    ##     self: MzQCcontrolledVocabulary, R6
    ##     toJSON: function (...)
    ##     uri: https://github.com/HUPO-PSI/psi-ms-CV/releases/download/ ...
    ##     version: 4.1.195

    ## test if the default CV is usable
    toQCMetric(id = "MS:4000059", value = 13405) ## number of MS1 scans

    ## <MzQCqualityMetric>
    ##   Public:
    ##     accession: MS:4000059
    ##     clone: function (deep = FALSE)
    ##     description: "The number of MS1 events in the run." [PSI:MS]
    ##     fromData: function (data, context = "MzQCqualityMetric")
    ##     initialize: function (accession = NA_character_, name = NA_character_, description = NA_character_,
    ##     isValid: function (context = "MzQCqualityMetric")
    ##     name: number of MS1 spectra
    ##     self: MzQCqualityMetric, R6
    ##     toJSON: function (...)
    ##     unit: list
    ##     value: 13405

However, if you happen to run this code without an internet connection, it will fall back to the PSI-MS CV which is shipped with the rmzqc package (which may not contain the latest CV terms)

    ## With internet:
    myCV = getCVSingleton()
    myCV$setData(getCVDictionary("latest")) ## this is done internally by default when you load the package

    ## Downloading obo from 'https://github.com/HUPO-PSI/psi-ms-CV/releases/download/v4.1.195/psi-ms.obo' ...

    cat("Number of entries in latest CV: ", nrow(getCVSingleton()$getCV()), "\n")

    ## Number of entries in latest CV:  6813

    print(getCVInfo())

    ## <MzQCcontrolledVocabulary>
    ##   Public:
    ##     clone: function (deep = FALSE)
    ##     fromData: function (data, context = "MzQCcontrolledVocabulary")
    ##     initialize: function (name = NA_character_, uri = NA_character_, version = NA_character_)
    ##     isValid: function (context = "MzQCcontrolledVocabulary")
    ##     name: Proteomics Standards Initiative Mass Spectrometry Ontology
    ##     self: MzQCcontrolledVocabulary, R6
    ##     toJSON: function (...)
    ##     uri: https://github.com/HUPO-PSI/psi-ms-CV/releases/download/ ...
    ##     version: 4.1.195

    ## simulate missing internet connection by invoking the function manually
    myCV$setData(getCVDictionary("local"))
    cat("Number of entries in local CV: ", nrow(getCVSingleton()$getCV()), "\n")

    ## Number of entries in local CV:  6806

    print(getCVInfo())

    ## <MzQCcontrolledVocabulary>
    ##   Public:
    ##     clone: function (deep = FALSE)
    ##     fromData: function (data, context = "MzQCcontrolledVocabulary")
    ##     initialize: function (name = NA_character_, uri = NA_character_, version = NA_character_)
    ##     isValid: function (context = "MzQCcontrolledVocabulary")
    ##     name: Proteomics Standards Initiative Mass Spectrometry Ontology
    ##     self: MzQCcontrolledVocabulary, R6
    ##     toJSON: function (...)
    ##     uri: https://github.com/HUPO-PSI/psi-ms-CV/releases/download/ ...
    ##     version: 4.1.193

Now, the package’s PSI-MS CV might still not suit you, and you want to use the latest unpublished CV, which you downloaded somewhere, or which you handcrafted for testing. Then simply use a custom .obo file:

    myOBO = system.file("./cv/psi-ms.obo", package="rmzqc") ## we will use a local file, but you can point to anything you have (even URI's)
    myCV$setData(getCVDictionary("custom", myOBO))
    cat("Number of entries in custom CV: ", nrow(getCVSingleton()$getCV()), "\n")

    ## Number of entries in custom CV:  6806

    print(getCVInfo())

    ## <MzQCcontrolledVocabulary>
    ##   Public:
    ##     clone: function (deep = FALSE)
    ##     fromData: function (data, context = "MzQCcontrolledVocabulary")
    ##     initialize: function (name = NA_character_, uri = NA_character_, version = NA_character_)
    ##     isValid: function (context = "MzQCcontrolledVocabulary")
    ##     name: Proteomics Standards Initiative Mass Spectrometry Ontology
    ##     self: MzQCcontrolledVocabulary, R6
    ##     toJSON: function (...)
    ##     uri: C:/Users/bielow/AppData/Local/Temp/RtmpwpycmK/Rinstfa883 ...
    ##     version: 4.1.193

    ## you may want to change the CV-entries, or URI or version manually, before creating an mzQC file:
    newCV = list(CV = myCV$getData()$CV,
                 URI = "https://myURI.com",
                 version = "9.9.2")
    myCV$setData(newCV)
    print(getCVInfo())

    ## <MzQCcontrolledVocabulary>
    ##   Public:
    ##     clone: function (deep = FALSE)
    ##     fromData: function (data, context = "MzQCcontrolledVocabulary")
    ##     initialize: function (name = NA_character_, uri = NA_character_, version = NA_character_)
    ##     isValid: function (context = "MzQCcontrolledVocabulary")
    ##     name: Proteomics Standards Initiative Mass Spectrometry Ontology
    ##     self: MzQCcontrolledVocabulary, R6
    ##     toJSON: function (...)
    ##     uri: https://myURI.com
    ##     version: 9.9.2