library("tima")
copy_backbone()
go_to_cache()
prepare_annotations_sirius()
unlink("data", recursive = TRUE)Prepare annotations SIRIUS
Description
Prepares SIRIUS annotation results (structure predictions, CANOPUS chemical classifications, and formula predictions) by harmonizing formats across SIRIUS versions (v5/v6), standardizing column names, and integrating with structure metadata.
Usage
prepare_annotations_sirius(
input_directory = get_params(step =
"prepare_annotations_sirius")\$files\$annotations\$raw\$sirius,
output_ann = get_params(step =
"prepare_annotations_sirius")\$files\$annotations\$prepared\$structural\$sirius,
output_can = get_params(step =
"prepare_annotations_sirius")\$files\$annotations\$prepared\$canopus,
output_for = get_params(step =
"prepare_annotations_sirius")\$files\$annotations\$prepared\$formula,
sirius_version = get_params(step = "prepare_annotations_sirius")\$tools\$sirius\$version,
str_stereo = get_params(step =
"prepare_annotations_sirius")\$files\$libraries\$sop\$merged\$structures\$stereo,
str_met = get_params(step =
"prepare_annotations_sirius")\$files\$libraries\$sop\$merged\$structures\$metadata,
str_nam = get_params(step =
"prepare_annotations_sirius")\$files\$libraries\$sop\$merged\$structures\$names,
str_tax_cla = get_params(step =
"prepare_annotations_sirius")\$files\$libraries\$sop\$merged\$structures\$taxonomies\$cla,
str_tax_npc = get_params(step =
"prepare_annotations_sirius")\$files\$libraries\$sop\$merged\$structures\$taxonomies\$npc,
max_analog_abs_mz_error = get_params(step =
"prepare_annotations_sirius")\$tools\$sirius\$max_analog_abs_mz_error
)
Arguments
input_directory
|
character Character path to directory or zip file containing SIRIUS results. |
output_ann
|
character Character path for prepared structure annotation output. |
output_can
|
character Character path for prepared CANOPUS output. |
output_for
|
character Character path for prepared formula output. |
sirius_version
|
character Character SIRIUS version ("5" or "6"). |
str_stereo
|
character Character path to structure stereochemistry file. |
str_met
|
character Character path to structure metadata file. |
str_nam
|
character Character path to structure names file. |
str_tax_cla
|
character Character path to ClassyFire taxonomy file. |
str_tax_npc
|
character Character path to NPClassifier taxonomy file. |
max_analog_abs_mz_error
|
numeric Maximum allowed absolute m/z deviation (Da) for keeping SIRIUS spectral analog hits. |
Details
This function:
-
Validates inputs (version, paths, file existence).
-
Loads SIRIUS output files (CANOPUS, formulas, structures, denovo, spectral matches).
-
Harmonizes column names across SIRIUS v5 and v6.
-
Joins with structure metadata (stereochemistry, names, taxonomy).
-
Splits results into three output files: annotations, CANOPUS, formulas.
-
Exports parameters and results.
If the input directory does not exist, returns an empty template with expected columns to ensure downstream compatibility.
Value
Character path to the prepared SIRIUS annotations file (invisible).
See Also
Other preparation: prepare_annotations_gnps(), prepare_annotations_mzmine(), prepare_annotations_spectra(), prepare_features_components(), prepare_features_edges(), prepare_features_tables(), prepare_libraries_rt(), prepare_libraries_sop_bigg(), prepare_libraries_sop_closed(), prepare_libraries_sop_ecmdb(), prepare_libraries_sop_hmdb(), prepare_libraries_sop_lotus(), prepare_libraries_sop_merged(), prepare_libraries_spectra(), prepare_params(), prepare_taxa()