Motivation | Setup | Basic usage | Allowing the user to hide a message | Setting an expiry time | Using onetime in your package | Utility functions | Going further
Package: onetime 0.2.0
onetime: Run Code Only Once
Allows code to be run only once on a given computer, using lockfiles. Typical use cases include startup messages shown only when a package is loaded for the very first time.
Authors:
onetime_0.2.0.tar.gz
onetime_0.2.0.zip(r-4.7)onetime_0.2.0.zip(r-4.6)onetime_0.2.0.zip(r-4.5)
onetime_0.2.0.tgz(r-4.6-any)onetime_0.2.0.tgz(r-4.5-any)
onetime_0.2.0.tar.gz(r-4.7-any)onetime_0.2.0.tar.gz(r-4.6-any)
onetime_0.2.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
onetime/json (API)
| # Install 'onetime' in R: |
| install.packages('onetime', repos = c('https://hughjonesd.r-universe.dev', 'https://cloud.r-project.org')) |
Bug tracker:https://github.com/hughjonesd/onetime/issues
Pkgdown/docs site:https://hughjonesd.github.io
Last updated from:e36294db9b (on CRAN-0.2.0). Checks:9 OK. Indexed: yes.
| Target | Result | Time | Files | Syslog |
|---|---|---|---|---|
| linux-devel-x86_64 | OK | 165 | ||
| source / vignettes | OK | 215 | ||
| linux-release-x86_64 | OK | 140 | ||
| macos-release-arm64 | OK | 95 | ||
| macos-oldrel-arm64 | OK | 113 | ||
| windows-devel | OK | 85 | ||
| windows-release | OK | 85 | ||
| windows-oldrel | OK | 88 | ||
| wasm-release | OK | 111 |
Exports:check_ok_to_storeonetime_been_doneonetime_dironetime_doonetime_mark_as_doneonetime_messageonetime_message_confirmonetime_onlyonetime_resetonetime_rlang_informonetime_rlang_warnonetime_startup_messageonetime_warningset_ok_to_store
Readme and manuals
Help Manual
| Help page | Topics |
|---|---|
| Check if the package has permission to store files on the user's computer | check_ok_to_store |
| Run code only once | onetime-package onetime |
| Check if a onetime call has already been made | onetime_been_done |
| Return a path to a directory beneath the onetime base directory | onetime_dir |
| Run code only once | onetime_do |
| Mark an action as done | onetime_mark_as_done |
| Print a message, and ask for confirmation to hide it in future | onetime_message_confirm |
| Wrap a function to be called only once | onetime_only |
| Reset a onetime call by ID | onetime_reset |
| Print a warning or message only once | onetime_message onetime_startup_message onetime_warning |
| Print a warning or message only once using 'rlang' functions | onetime-rlang onetime_rlang_inform onetime_rlang_warn |
| Grant or revoke permission to store lockfiles on the user's computer | set_ok_to_store |
