doc

taxonomicallyinformedannotation · Aug 13, 2024 · ba45084 · ba45084
1 parent 11bb718
commit ba45084
Show file tree

Hide file tree

Showing 7 changed files with 16 additions and 7 deletions.
diff --git a/R/get_default_paths.R b/R/get_default_paths.R
@@ -13,7 +13,7 @@ import::from(yaml, read_yaml, .into = environment())
 #'
 #' @export
 #'
-#' @examples NULL
+#' @examples get_default_paths()
 get_default_paths <- function(yaml = system.file("extdata", "paths.yaml", package = "tima")) {
  ## Read the YAML file containing the paths
  paths <- read_yaml(file = yaml)

diff --git a/R/get_example_files.R b/R/get_example_files.R
@@ -14,7 +14,7 @@
 #'
 #' @export
 #'
-#' @examples NULL
+#' @examples get_example_files(example = c("features"), in_cache = FALSE)
 get_example_files <- function(example = c("features", "metadata", "sirius", "spectra"), in_cache = TRUE) {
  stopifnot(
  "Example files available are `features`, `hmdb_is`, `metadata`, `sirius`, `spectra` and `spectral_lib_with_rt`." =

diff --git a/R/get_last_version_from_zenodo.R b/R/get_last_version_from_zenodo.R
@@ -24,7 +24,12 @@ import::from(stringi, stri_replace_all_fixed, .into = environment())
 #'
 #' @export
 #'
-#' @examples NULL
+#' @examples
+#' get_last_version_from_zenodo(
+#' doi = "10.5281/zenodo.5794106",
+#' pattern = "frozen.csv.gz",
+#' path = "frozen.csv.gz"
+#' )
 get_last_version_from_zenodo <-
  function(doi, pattern, path) {
  ## Remove the prefix from the DOI

diff --git a/codemeta.json b/codemeta.json
@@ -526,7 +526,7 @@
  "SystemRequirements": null
  },
  "keywords": ["metaboliteannotation", "chemotaxonomy", "scoringsystem", "naturalproducts", "computationalmetabolomics", "taxonomicdistance", "specializedmetabolome"],
- "fileSize": "3249.803KB",
+ "fileSize": "3250.19KB",
  "citation": [
  {
  "@type": "ScholarlyArticle",

diff --git a/man/get_default_paths.Rd b/man/get_default_paths.Rd
diff --git a/man/get_example_files.Rd b/man/get_example_files.Rd
diff --git a/man/get_last_version_from_zenodo.Rd b/man/get_last_version_from_zenodo.Rd