put compound names in documentation

Meredith-Lab · Nov 16, 2023 · 77b496f · 77b496f
1 parent 1449a28
commit 77b496f
Show file tree

Hide file tree

Showing 3 changed files with 17 additions and 0 deletions.
diff --git a/NEWS.md b/NEWS.md
@@ -6,6 +6,7 @@
 * The `pathway_ids` argument of `get_mol_kegg()` now also accepts pathway *module* IDs (e.g. "M00082")
 * `get_mol_kegg()` got a significant speed improvement (#84)
 * `get_mol_kegg()` will skip downloading a .mol file if it is already present by default (override with `force=TRUE`)
+* New example mol files were added.  See `?mol_example()`
 
 # volcalc 2.0.0
 

diff --git a/R/mol_example.R b/R/mol_example.R
@@ -5,6 +5,12 @@
 #'
 #' @param path Name of file.  If `NULL` (default), the options for example .mol
 #'   files will be listed instead.
+#' @details File names are the KEGG identifiers.  Compound names are as follows:
+#' - C00031: D-Glucose
+#' - C08491: (-)-Jasmonic acid
+#' - C16181: beta-2,3,4,5,6-Pentachlorocyclohexanol
+#' - C16286: Geosmin
+#' - C16521: Isoprene
 #'
 #' @export
 #'

diff --git a/man/mol_example.Rd b/man/mol_example.Rd