From 13b03bdc1c537833881ab0a58d875de973ef4815 Mon Sep 17 00:00:00 2001 From: Henrik Bengtsson Date: Mon, 28 Oct 2024 22:45:53 -0700 Subject: [PATCH] Updated 'gh-pages' from docs/ folder --- 404.html | 2 +- CONDUCT.html | 2 +- CONTRIBUTING.html | 2 +- articles/index.html | 2 +- articles/progressr-intro.html | 2 +- authors.html | 6 +++--- index.html | 2 +- news/index.html | 8 +++---- pkgdown.yml | 2 +- reference/global_progression_handler.html | 2 +- reference/handler_ascii_alert.html | 2 +- reference/handler_beepr.html | 2 +- reference/handler_cli.html | 2 +- reference/handler_debug.html | 2 +- reference/handler_filesize.html | 2 +- reference/handler_newline.html | 2 +- reference/handler_notifier.html | 2 +- reference/handler_ntfy.html | 21 +++++++------------ reference/handler_pbcol.html | 2 +- reference/handler_pbmcapply.html | 2 +- reference/handler_progress.html | 2 +- reference/handler_rpushbullet.html | 2 +- reference/handler_rstudio.html | 2 +- reference/handler_shiny.html | 2 +- reference/handler_tkprogressbar.html | 2 +- reference/handler_txtprogressbar.html | 2 +- reference/handler_void.html | 2 +- reference/handler_winprogressbar.html | 2 +- reference/handlers.html | 2 +- reference/index.html | 2 +- reference/make_progression_handler.html | 2 +- reference/progress.html | 2 +- reference/progress_aggregator.html | 2 +- reference/progress_progressr.html | 2 +- reference/progression.html | 2 +- reference/progressor.html | 2 +- reference/progressr.html | 2 +- reference/progressr.options.html | 2 +- .../register_global_progression_handler.html | 2 +- reference/slow_sum.html | 2 +- reference/withProgressShiny.html | 2 +- reference/with_progress.html | 4 ++-- 42 files changed, 54 insertions(+), 61 deletions(-) diff --git a/404.html b/404.html index 902c02c..2fda478 100644 --- a/404.html +++ b/404.html @@ -46,7 +46,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/CONDUCT.html b/CONDUCT.html index c8a2615..ee3e70a 100644 --- a/CONDUCT.html +++ b/CONDUCT.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/CONTRIBUTING.html b/CONTRIBUTING.html index 93b9cea..12ac4bc 100644 --- a/CONTRIBUTING.html +++ b/CONTRIBUTING.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/articles/index.html b/articles/index.html index 99f5942..5b7b8f8 100644 --- a/articles/index.html +++ b/articles/index.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/articles/progressr-intro.html b/articles/progressr-intro.html index 84418a3..b3ba164 100644 --- a/articles/progressr-intro.html +++ b/articles/progressr-intro.html @@ -46,7 +46,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/authors.html b/authors.html index 54a58e6..14d2e4d 100644 --- a/authors.html +++ b/authors.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 @@ -151,14 +151,14 @@

Citation

Bengtsson H (2024). progressr: An Inclusive, Unifying API for Progress Updates. -R package version 0.14.0-9010, +R package version 0.15.0, https://github.com/futureverse/progressr, https://progressr.futureverse.org. 

@Manual{,
   title = {progressr: An Inclusive, Unifying API for Progress Updates},
   author = {Henrik Bengtsson},
   year = {2024},
-  note = {R package version 0.14.0-9010,
+  note = {R package version 0.15.0,
         https://github.com/futureverse/progressr},
   url = {https://progressr.futureverse.org},
 }
diff --git a/index.html b/index.html index 1133fcc..b1fca40 100644 --- a/index.html +++ b/index.html @@ -47,7 +47,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/news/index.html b/news/index.html index 4c73361..6929edd 100644 --- a/news/index.html +++ b/news/index.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 @@ -136,13 +136,13 @@

Changelog

-

Version (development version)

+

Version 0.15.0

-

New Features

+

New Features

  • Add handler_ntfy() for reporting on progress via the Ntfy.sh Messaging Service using the ntfy package.
-

Bug Fixes

+

Bug Fixes

  • withProgressShiny() could produce an `if (config$max_steps ==

    1. : … argument is of length zero` error.
      2. diff --git a/pkgdown.yml b/pkgdown.yml index 8ccbc5d..2c02ab4 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.1.1 pkgdown_sha: ~ articles: progressr-intro: progressr-intro.html -last_built: 2024-10-28T18:11Z +last_built: 2024-10-29T05:45Z urls: reference: https://progressr.futureverse.org/reference article: https://progressr.futureverse.org/articles diff --git a/reference/global_progression_handler.html b/reference/global_progression_handler.html index a9ed331..feb6f22 100644 --- a/reference/global_progression_handler.html +++ b/reference/global_progression_handler.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0
diff --git a/reference/handler_ascii_alert.html b/reference/handler_ascii_alert.html index a7e52ee..cef8f0a 100644 --- a/reference/handler_ascii_alert.html +++ b/reference/handler_ascii_alert.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0
diff --git a/reference/handler_beepr.html b/reference/handler_beepr.html index 8f40394..9ce8935 100644 --- a/reference/handler_beepr.html +++ b/reference/handler_beepr.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_cli.html b/reference/handler_cli.html index 22e40ce..6dc1b88 100644 --- a/reference/handler_cli.html +++ b/reference/handler_cli.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_debug.html b/reference/handler_debug.html index a164668..e800f30 100644 --- a/reference/handler_debug.html +++ b/reference/handler_debug.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_filesize.html b/reference/handler_filesize.html index a596474..088d538 100644 --- a/reference/handler_filesize.html +++ b/reference/handler_filesize.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_newline.html b/reference/handler_newline.html index 4324d72..a1d6e41 100644 --- a/reference/handler_newline.html +++ b/reference/handler_newline.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_notifier.html b/reference/handler_notifier.html index 1e48209..a507ce1 100644 --- a/reference/handler_notifier.html +++ b/reference/handler_notifier.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_ntfy.html b/reference/handler_ntfy.html index ab19694..418bd7a 100644 --- a/reference/handler_ntfy.html +++ b/reference/handler_ntfy.html @@ -24,7 +24,7 @@ progressr - 0.14.0-9010 + 0.15.0 @@ -133,7 +133,7 @@

Progression Handler: Progress Reported via the Ntfy.sh Messaging Service

- Source: R/handler_nfty.R + Source: R/handler_ntfy.R
@@ -185,26 +185,19 @@

Requirements

Examples

pkg <- "ntfy"
 if (requireNamespace(pkg, quietly = TRUE)) {
+  ## We need to specify a ntfy.sh topic that progress messages
+  ## should be sent to. See help("ntfy_topic", package = "ntfy")
+  ## for details
+  Sys.setenv("NTFY_TOPIC", "R-my-secret-topic")
 
   handlers("ntfy")
   with_progress({ y <- slow_sum(1:10) })
   print(y)
-  
 }
 #> Topic not yet set - using a demo topic 'mytopic'
 #> Set one with usethis::edit_r_environ()
 #>  and set NTFY_TOPIC='<yourSecretTopic>'
-#> M: Added value 1
-#> M: Added value 2
-#> M: Added value 3
-#> M: Added value 4
-#> M: Added value 5
-#> M: Added value 6
-#> M: Added value 7
-#> M: Added value 8
-#> M: Added value 9
-#> M: Added value 10
-#> [1] 55
+#> Error in Sys.setenv("NTFY_TOPIC", "R-my-secret-topic"): all arguments must be named
diff --git a/reference/handler_pbcol.html b/reference/handler_pbcol.html index edcc4e9..53aa01d 100644 --- a/reference/handler_pbcol.html +++ b/reference/handler_pbcol.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_pbmcapply.html b/reference/handler_pbmcapply.html index bd5906d..97fbe2c 100644 --- a/reference/handler_pbmcapply.html +++ b/reference/handler_pbmcapply.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_progress.html b/reference/handler_progress.html index 6caa266..991e4fd 100644 --- a/reference/handler_progress.html +++ b/reference/handler_progress.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_rpushbullet.html b/reference/handler_rpushbullet.html index f9179f1..ae7a752 100644 --- a/reference/handler_rpushbullet.html +++ b/reference/handler_rpushbullet.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_rstudio.html b/reference/handler_rstudio.html index c1ff9c5..40b01e0 100644 --- a/reference/handler_rstudio.html +++ b/reference/handler_rstudio.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_shiny.html b/reference/handler_shiny.html index 51aba25..c1124a5 100644 --- a/reference/handler_shiny.html +++ b/reference/handler_shiny.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_tkprogressbar.html b/reference/handler_tkprogressbar.html index 91a9006..2a9582a 100644 --- a/reference/handler_tkprogressbar.html +++ b/reference/handler_tkprogressbar.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_txtprogressbar.html b/reference/handler_txtprogressbar.html index 44fcc71..73238c7 100644 --- a/reference/handler_txtprogressbar.html +++ b/reference/handler_txtprogressbar.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_void.html b/reference/handler_void.html index 22abfae..2f67884 100644 --- a/reference/handler_void.html +++ b/reference/handler_void.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handler_winprogressbar.html b/reference/handler_winprogressbar.html index 31817be..fba4af6 100644 --- a/reference/handler_winprogressbar.html +++ b/reference/handler_winprogressbar.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/handlers.html b/reference/handlers.html index c9fd52e..79a474d 100644 --- a/reference/handlers.html +++ b/reference/handlers.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/index.html b/reference/index.html index 0bc1f49..af40c48 100644 --- a/reference/index.html +++ b/reference/index.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/make_progression_handler.html b/reference/make_progression_handler.html index a2bb309..502420e 100644 --- a/reference/make_progression_handler.html +++ b/reference/make_progression_handler.html @@ -26,7 +26,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progress.html b/reference/progress.html index 0e19287..53a4d0e 100644 --- a/reference/progress.html +++ b/reference/progress.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progress_aggregator.html b/reference/progress_aggregator.html index 0b79815..451240d 100644 --- a/reference/progress_aggregator.html +++ b/reference/progress_aggregator.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progress_progressr.html b/reference/progress_progressr.html index d8e75c0..40dd98c 100644 --- a/reference/progress_progressr.html +++ b/reference/progress_progressr.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progression.html b/reference/progression.html index 70bf834..5f558e0 100644 --- a/reference/progression.html +++ b/reference/progression.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progressor.html b/reference/progressor.html index 193c601..417aa0a 100644 --- a/reference/progressor.html +++ b/reference/progressor.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progressr.html b/reference/progressr.html index 4b68e15..7abd322 100644 --- a/reference/progressr.html +++ b/reference/progressr.html @@ -25,7 +25,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/progressr.options.html b/reference/progressr.options.html index d8e688a..629bf6f 100644 --- a/reference/progressr.options.html +++ b/reference/progressr.options.html @@ -27,7 +27,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/register_global_progression_handler.html b/reference/register_global_progression_handler.html index 99832de..25a8bc5 100644 --- a/reference/register_global_progression_handler.html +++ b/reference/register_global_progression_handler.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/slow_sum.html b/reference/slow_sum.html index 93d5499..161fd5a 100644 --- a/reference/slow_sum.html +++ b/reference/slow_sum.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/withProgressShiny.html b/reference/withProgressShiny.html index 57bf418..0163af7 100644 --- a/reference/withProgressShiny.html +++ b/reference/withProgressShiny.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 diff --git a/reference/with_progress.html b/reference/with_progress.html index 5b373cf..25519ce 100644 --- a/reference/with_progress.html +++ b/reference/with_progress.html @@ -23,7 +23,7 @@ progressr - 0.14.0-9010 + 0.15.0 @@ -297,7 +297,7 @@

Examples

#> p(amount = 0) #> sum #> } -#> <bytecode: 0x59e84d166f18> +#> <bytecode: 0x5816228dc680> #> <environment: namespace:progressr> x <- 1:10