diff --git a/R/get_default_paths.R b/R/get_default_paths.R index 235d6211..b2e556a8 100644 --- 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 index a5b809f9..40e3c261 100644 --- 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 index 545ffb09..dcf794c4 100644 --- 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 index 9b779861..27a3c13c 100644 --- 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 index 5b535e9e..114409d7 100644 --- a/man/get_default_paths.Rd +++ b/man/get_default_paths.Rd @@ -19,5 +19,5 @@ A list containing the paths specified in the YAML file This function gets default paths } \examples{ -NULL +get_default_paths() } diff --git a/man/get_example_files.Rd b/man/get_example_files.Rd index c4f39ae7..a609402e 100644 --- a/man/get_example_files.Rd +++ b/man/get_example_files.Rd @@ -21,5 +21,5 @@ Example files. This function downloads example files } \examples{ -NULL +get_example_files(example = c("features"), in_cache = FALSE) } diff --git a/man/get_last_version_from_zenodo.Rd b/man/get_last_version_from_zenodo.Rd index 89ad5194..341e0e0c 100644 --- a/man/get_last_version_from_zenodo.Rd +++ b/man/get_last_version_from_zenodo.Rd @@ -25,5 +25,9 @@ Credit goes to partially to https://inbo.github.io/inborutils/ } \examples{ -NULL +get_last_version_from_zenodo( + doi = "10.5281/zenodo.5794106", + pattern = "frozen.csv.gz", + path = "frozen.csv.gz" +) }