Man pages for rmzqc
Creation, Reading and Validation of 'mzqc' Files

check_field_existsCheck if a field exists in data and warn if it doesn't, then...
check_typeChecks the value's class type, which should match at least of...
checkUnexpectedFieldsCheck for unexpected fields in data and warn if any are found
CV_CV_
filenameToCVFor a given filename (e.g. "test.mzML"), check the suffix and...
fromDatatoMzQCAllow conversion of plain named lists of R objects (from...
fromDatatoMzQCobjAllow conversion of a plain R object (obtained from jSON) to...
getCVDictionaryFetch and parse the 'psi-ms.obo' and some metadata from the...
getCVInfoReturns an 'MzQCcontrolledVocabulary' for the currently used...
getCVSingletonReturns the CV singleton. See 'CV_'.
getCVTemplateFills a MzQCcvParameter object with id(accession) and name....
getDefaultCVReturns an MzQCcontrolledVocabulary for the currently used CV...
getLatest_PSICV_URLGet the latest PSI-MS CV release URL
getLocal_CV_VersionObtains the 'data-version' from a local (i.e. non-url)...
getOptionalValueGet an optional value from data, using a default if not...
getQualityMetricTemplateFills a MzQCqualityMetric object with id(accession) and name....
getSyntaxValidatorGet a syntax validator for mzQC
hasFileSuffixChecks if filepath ends in suffix (ignoring lower/upper case...
isUndefinedTell if a variable's value is undefined (NA or NULL); If yes,...
isValidMzQCChecks validity (= completeness) of mzQC objects - or lists...
localFileToURIConvert a local filename, e.g. "./myData/test.mzML" to a...
MzQCanalysisSoftware-classDetails of the software used to create the QC metrics
MzQCbaseQuality-classBase class of runQuality/setQuality
MzQCbaseQuality_getMetricExtract a certain metric from a runQuality's list of...
MzQCcontrolledVocabulary-classA controlled vocabulary document, usually pointing to an .obo...
MzQCcvParameter-classA controlled vocabulary parameter, as detailed in the OBO...
MzQCDateTime-classAn mzQC-formatted date+time in ISO8601 format, as required by...
MzQCinputFile-classAn inputfile within metadata for a run/setQuality
MzQCmetadata-classThe metadata for a run/setQuality
MzQCmzQC-classRoot element of an mzQC document
MzQCqualityMetric-classThe central class to store QC information
MzQCrunQuality-classA runQuality object. Use to report metrics for individual...
MzQCsetQuality-classA setQuality object. Use it for metrics which are specific to...
NULL_to_charNAConverts a NULL to NA_character_; or returns the argument...
NULL_to_NAConverts a NULL to NA; or returns the argument unchanged...
parseOBOGet the information of each CV term from an obo file.
readMZQCRead a JSON file in mzQC format into an MzQCmzQC root object
readMZQCFromJSONRead a JSON object in mzQC format into an MzQCmzQC root...
removeFileSuffixRemoves the last suffix (including the last dot) from a...
removeIfExistsRemove a file, if it exists (useful for temporary files which...
rmzqc-packagermzqc: Creation, Reading and Validation of 'mzqc' Files
toAnalysisSoftwareFrom an ID, e.g. "MS:1003162" (for PTX-QC), and some...
toQCMetricCreate an 'MzQCqualityMetric' object from two inputs (id and...
validateFromFileSyntactically validates an mzQC document which is present as...
validateFromObjSyntactically validates an mzQC document which is already in...
validateFromStringSyntactically validates an mzQC document which is already in...
writeMZQCWrites a full mzQC object to disk.
rmzqc documentation built on June 8, 2025, 1:59 p.m.