diff options
| author | Johannes Ranke <johannes.ranke@jrwb.de> | 2026-03-05 15:47:24 +0100 |
|---|---|---|
| committer | Johannes Ranke <johannes.ranke@jrwb.de> | 2026-03-05 15:47:24 +0100 |
| commit | abe52f193a71403dcb3e6e71b2f89d215652c5f0 (patch) | |
| tree | b6ecef75eca11a441471abfa9b551c39da21002a | |
| parent | 63b5837a0c99e916ee57d778879f7aef57e86e88 (diff) | |
Don't run examples per default
This is because PubChem and BCPC could be unavailable, e.g.
on R-Universe or CRAN.
| -rw-r--r-- | R/chent.R | 9 | ||||
| -rw-r--r-- | man/chent.Rd | 3 | ||||
| -rw-r--r-- | man/pai.Rd | 3 | ||||
| -rw-r--r-- | man/plot.chent.Rd | 3 |
4 files changed, 18 insertions, 0 deletions
@@ -40,6 +40,8 @@ #' @param file The file to write to #' @param dir The directory to write the file to #' @examples +#' # Don't run examples per default, as PubChem may be unavailable +#' \dontrun{ #' caffeine <- chent$new("caffeine") #' print(caffeine) #' if (!is.null(caffeine$Picture)) { @@ -47,6 +49,7 @@ #' } #' oct <- chent$new("1-octanol", smiles = "CCCCCCCCO", pubchem = FALSE) #' print(oct) +#' } chent <- R6Class("chent", public = list( #' @field identifier (`character(1)`)\cr @@ -630,11 +633,14 @@ draw_svg.chent = function(x, width = 300, height = 150, #' @param ... Further arguments passed to [grImport::grid.picture] #' @export #' @examples +#' # Don't run examples per default, as PubChem may be unavailable +#' \dontrun{ #' caffeine <- chent$new("caffeine") #' print(caffeine) #' if (!is.null(caffeine$Picture)) { #' plot(caffeine) #' } +#' } plot.chent = function(x, ...) { if (is.null(x$Picture)) stop("No Picture object in chent, was RDKit available during creation?") grid.picture(x$Picture) @@ -651,6 +657,8 @@ plot.chent = function(x, ...) { #' @export #' @format An [R6::R6Class] generator object #' @examples +#' # Don't run examples per default, as PubChem may be unavailable +#' \dontrun{ #' atr <- pai$new("atrazine") #' print(atr) #' if (!is.null(atr$Picture)) { @@ -659,6 +667,7 @@ plot.chent = function(x, ...) { #' # We can also define pais that are not found on the BCPC site #' decanol <- pai$new("1-Decanol") #' print(decanol) +#' } pai <- R6Class("pai", inherit = chent, public = list( diff --git a/man/chent.Rd b/man/chent.Rd index 464c759..b348070 100644 --- a/man/chent.Rd +++ b/man/chent.Rd @@ -12,6 +12,8 @@ information is retrieved from the internet. Additionally, it can be generated using RDKit if RDKit and its python bindings are installed. } \examples{ +# Don't run examples per default, as PubChem may be unavailable +\dontrun{ caffeine <- chent$new("caffeine") print(caffeine) if (!is.null(caffeine$Picture)) { @@ -20,6 +22,7 @@ if (!is.null(caffeine$Picture)) { oct <- chent$new("1-octanol", smiles = "CCCCCCCCO", pubchem = FALSE) print(oct) } +} \section{Public fields}{ \if{html}{\out{<div class="r6-fields">}} \describe{ @@ -14,6 +14,8 @@ the complete result of querying the BCPC compendium using \link[webchem:bcpc_query]{bcpc_query}. } \examples{ +# Don't run examples per default, as PubChem may be unavailable +\dontrun{ atr <- pai$new("atrazine") print(atr) if (!is.null(atr$Picture)) { @@ -23,6 +25,7 @@ if (!is.null(atr$Picture)) { decanol <- pai$new("1-Decanol") print(decanol) } +} \section{Super class}{ \code{\link[chents:chent]{chents::chent}} -> \code{pai} } diff --git a/man/plot.chent.Rd b/man/plot.chent.Rd index ecaa01b..1ac1be6 100644 --- a/man/plot.chent.Rd +++ b/man/plot.chent.Rd @@ -15,9 +15,12 @@ Plot method for chent objects } \examples{ +# Don't run examples per default, as PubChem may be unavailable +\dontrun{ caffeine <- chent$new("caffeine") print(caffeine) if (!is.null(caffeine$Picture)) { plot(caffeine) } } +} |
