beanumber / tidychangepoint

Changepoint detection with a tidy interface
https://beanumber.github.io/tidychangepoint/
GNU General Public License v3.0
1 stars 1 forks source link

CRAN: fix \dontrun{} and \donttest{} #112

Closed beanumber closed 2 months ago

beanumber commented 2 months ago

\dontrun{} should only be used if the example really cannot be executed (e.g. because of missing additional software, missing API keys, ...) by the user. That's why wrapping examples in \dontrun{} adds the comment ("# Not run:") as a warning for the user. Does not seem necessary. Please replace \dontrun with \donttest. Please unwrap the examples if they are executable in < 5 sec, or replace dontrun{} with \donttest{}. Since you commented in segment_ga.Rd that "This will take a really long time!": If examples take several hours, wrappign them in \dontrun{} is fine, since we test \donttest{} examples occasionally.