Reduce check time of examples

DESCRIPTION

@@ -1,6 +1,6 @@
 Package: proffer
 Title: Profile R Code and Visualize with 'Pprof'
-Version: 0.1.2.9000
+Version: 0.1.3
 Encoding: UTF-8
 Language: en-US
 License: MIT + file LICENSE

NEWS.md

@@ -1,6 +1,6 @@
-# proffer 0.1.2.9000
-
+# proffer 0.1.3
 
+* Reduce check time of examples.
 
 # proffer 0.1.2
 

R/package.R

@@ -23,7 +23,7 @@
 #' @importFrom utils browseURL Rprof
 #' @importFrom withr with_path
 #' @examples
-#' \dontrun{
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' # Start a pprof virtual server in the background.
 #' px <- pprof(replicate(1e2, sample.int(1e4)))
 #' # Terminate the server.

R/path.R

@@ -6,7 +6,7 @@
 #'   for setup instructions.
 #' @return Character, path to `pprof` it exists and `""` otherwise.
 #' @examples
-#' \dontrun{
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' pprof_path()
 #' }
 pprof_path <- function() {

R/pprof.R

@@ -7,7 +7,7 @@
 #'   for setup instructions.
 #' @inheritParams pprof
 #' @examples
-#' \dontrun{
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' test_pprof()
 #' }
 test_pprof <- function(
@@ -45,7 +45,7 @@ test_pprof <- function(
 #' @param ... Additional arguments passed on to [Rprof()]
 #'   via [record_pprof()].
 #' @examples
-#' \dontrun{
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' # Start a pprof virtual server in the background.
 #' px <- pprof(replicate(1e2, sample.int(1e4)))
 #' # Terminate the server.
@@ -82,7 +82,7 @@ pprof <- function(
 #' @param rprof Path to profiling samples generated
 #'   by `Rprof()` or [record_rprof()].
 #' @examples
-#' \dontrun{
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' rprof <- record_rprof(replicate(1e2, sample.int(1e4)))
 #' # Start a pprof virtual server in the background.
 #' px <- serve_rprof(rprof)
@@ -129,7 +129,7 @@ serve_rprof <- function(
 #' @param verbose Logical, whether to print console messages
 #'   such as the URL of the local `pprof` server.
 #' @examples
-#' \dontrun{
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' pprof <- record_pprof(replicate(1e2, sample.int(1e4)))
 #' # Start a pprof virtual server in the background.
 #' px <- serve_pprof(pprof)
@@ -162,6 +162,8 @@ serve_pprof <- function(
 #' @return Port number, positive integer of length 1.
 #' @param lower Integer of length 1, lower bound of the port number.
 #' @param upper Integer of length 1, upper bound of the port number.
+#' @examples
+#' random_port()
 random_port <- function(lower = 49152L, upper = 65355L) {
   sample(seq.int(from = lower, to = upper, by = 1L), size = 1L)
 }

R/record.R

@@ -10,8 +10,10 @@
 #' @param ... Additional arguments passed on to [Rprof()]
 #'   via [record_rprof()].
 #' @examples
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' # Returns a path to pprof samples.
 #' record_pprof(replicate(1e2, sample.int(1e4)))
+#' }
 record_pprof <- function(expr, pprof = tempfile(), ...) {
   rprof <- record_rprof(expr, ...)
   to_pprof(rprof, pprof = pprof)
@@ -27,8 +29,10 @@ record_pprof <- function(expr, pprof = tempfile(), ...) {
 #'   Also returned from the function.
 #' @param ... Additional arguments passed on to [Rprof()].
 #' @examples
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' # Returns a path to Rprof samples.
 #' record_rprof(replicate(1e2, sample.int(1e4)))
+#' }
 record_rprof <- function(expr, rprof = tempfile(), ...) {
   on.exit(Rprof(NULL))
   Rprof(filename = rprof, ...)
@@ -43,8 +47,10 @@ record_rprof <- function(expr, rprof = tempfile(), ...) {
 #' @param rprof Path to Rprof samples.
 #' @param pprof Path to pprof samples.
 #' @examples
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' rprof <- record_rprof(replicate(1e2, sample.int(1e4)))
 #' to_pprof(rprof)
+#' }
 to_pprof <- function(rprof, pprof = tempfile()) {
   samples <- profile::read_rprof(path = rprof)
   profile::write_pprof(x = samples, path = pprof)
@@ -58,8 +64,10 @@ to_pprof <- function(rprof, pprof = tempfile()) {
 #' @param pprof Path to pprof samples.
 #' @param rprof Path to Rprof samples.
 #' @examples
+#' if (identical(Sys.getenv("PROFFER_EXAMPLES"), "true")) {
 #' pprof <- record_pprof(replicate(1e2, sample.int(1e4)))
 #' to_rprof(pprof)
+#' }
 to_rprof <- function(pprof, rprof = tempfile()) {
   samples <- profile::read_pprof(path = pprof)
   profile::write_rprof(x = samples, path = rprof)