From 760084a6c204d75890a02d80ff39da47370aa259 Mon Sep 17 00:00:00 2001
From: krlmlr <krlmlr@users.noreply.github.com>
Date: Sun, 10 Nov 2024 18:46:53 +0000
Subject: [PATCH] Built site for hmstimer@0.3.0.9000: b15d218

---
 pkgdown.yml                | 4 ++--
 reference/hms_timer.html   | 2 +-
 reference/tmr_elapsed.html | 8 ++++----
 reference/tmr_print.html   | 2 +-
 reference/tmr_start.html   | 4 ++--
 reference/tmr_stop.html    | 4 ++--
 search.json                | 2 +-
 7 files changed, 13 insertions(+), 13 deletions(-)

diff --git a/pkgdown.yml b/pkgdown.yml
index 9d3d76e..225e88d 100644
--- a/pkgdown.yml
+++ b/pkgdown.yml
@@ -1,8 +1,8 @@
 pandoc: 3.1.11
 pkgdown: 2.1.1.9000
-pkgdown_sha: 09588af3fedb96db3736401949ce244559ebde17
+pkgdown_sha: c40ba2c989e786bbb2829b431114d26375bbe19a
 articles: {}
-last_built: 2024-11-01T15:59Z
+last_built: 2024-11-10T18:46Z
 urls:
   reference: https://poissonconsulting.github.io/hmstimer/reference
   article: https://poissonconsulting.github.io/hmstimer/articles
diff --git a/reference/hms_timer.html b/reference/hms_timer.html
index c24f2cd..8c1799d 100644
--- a/reference/hms_timer.html
+++ b/reference/hms_timer.html
@@ -68,7 +68,7 @@ <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-e
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:01</span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu"><a href="tmr_elapsed.html">tmr_elapsed</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:01.102967</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:01.103028</span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></span>
 <span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:01</span>
 </code></pre></div>
diff --git a/reference/tmr_elapsed.html b/reference/tmr_elapsed.html
index c8d8ea0..b34bbf3 100644
--- a/reference/tmr_elapsed.html
+++ b/reference/tmr_elapsed.html
@@ -76,16 +76,16 @@ <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">tmr</span> <span class="op">&lt;-</span> <span class="fu"><a href="tmr_start.html">tmr_start</a></span><span class="op">(</span><span class="fu"><a href="tmr_timer.html">tmr_timer</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu">tmr_elapsed</span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000525</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000493</span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">0.01</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu">tmr_elapsed</span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.012148</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.012035</span>
 <span class="r-in"><span><span class="va">tmr</span> <span class="op">&lt;-</span> <span class="fu"><a href="tmr_stop.html">tmr_stop</a></span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu">tmr_elapsed</span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.013422</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.013096</span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">0.01</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu">tmr_elapsed</span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.013422</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.013096</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/reference/tmr_print.html b/reference/tmr_print.html
index ccdd16d..b13b36c 100644
--- a/reference/tmr_print.html
+++ b/reference/tmr_print.html
@@ -85,7 +85,7 @@ <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">x</span> <span class="op">&lt;-</span> <span class="fu"><a href="tmr_start.html">tmr_start</a></span><span class="op">(</span><span class="fu"><a href="tmr_timer.html">tmr_timer</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu">tmr_print</span><span class="op">(</span><span class="va">x</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "15:59:34 (+00:00:01 =&gt; 15:59:35)"</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> [1] "18:46:50 (+00:00:01 =&gt; 18:46:51)"</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/reference/tmr_start.html b/reference/tmr_start.html
index 76449dd..33753d1 100644
--- a/reference/tmr_start.html
+++ b/reference/tmr_start.html
@@ -85,10 +85,10 @@ <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">tmr</span> <span class="op">&lt;-</span> <span class="fu">tmr_start</span><span class="op">(</span><span class="fu"><a href="tmr_timer.html">tmr_timer</a></span><span class="op">(</span><span class="op">)</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu"><a href="tmr_elapsed.html">tmr_elapsed</a></span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000537</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000536</span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">0.01</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu"><a href="tmr_elapsed.html">tmr_elapsed</a></span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.012208</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.012168</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/reference/tmr_stop.html b/reference/tmr_stop.html
index 384ff57..a5927e6 100644
--- a/reference/tmr_stop.html
+++ b/reference/tmr_stop.html
@@ -74,10 +74,10 @@ <h2 id="see-also">See also<a class="anchor" aria-label="anchor" href="#see-also"
     <h2 id="ref-examples">Examples<a class="anchor" aria-label="anchor" href="#ref-examples"></a></h2>
     <div class="sourceCode"><pre class="sourceCode r"><code><span class="r-in"><span><span class="va">tmr</span> <span class="op">&lt;-</span> <span class="fu">tmr_stop</span><span class="op">(</span><span class="fu"><a href="tmr_timer.html">tmr_timer</a></span><span class="op">(</span>start <span class="op">=</span> <span class="cn">TRUE</span><span class="op">)</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu"><a href="tmr_elapsed.html">tmr_elapsed</a></span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000028</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000025</span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/Sys.sleep.html" class="external-link">Sys.sleep</a></span><span class="op">(</span><span class="fl">0.01</span><span class="op">)</span></span></span>
 <span class="r-in"><span><span class="fu"><a href="https://rdrr.io/r/base/print.html" class="external-link">print</a></span><span class="op">(</span><span class="fu"><a href="tmr_elapsed.html">tmr_elapsed</a></span><span class="op">(</span><span class="va">tmr</span><span class="op">)</span><span class="op">)</span></span></span>
-<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000028</span>
+<span class="r-out co"><span class="r-pr">#&gt;</span> 00:00:00.000025</span>
 </code></pre></div>
     </div>
   </main><aside class="col-md-3"><nav id="toc" aria-label="Table of contents"><h2>On this page</h2>
diff --git a/search.json b/search.json
index ab77b83..f4f5786 100644
--- a/search.json
+++ b/search.json
@@ -1 +1 @@
-[{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to hmstimer","title":"Contributing to hmstimer","text":"outlines propose change hmstimer.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to hmstimer","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to hmstimer","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to hmstimer","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"\", fork = TRUE). Install development dependences devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. Begin commit merge messages - indicate user facing changes included NEWS.md. use fledge automatically generate NEWS.md file.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to hmstimer","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to hmstimer","text":"Please note hmstimer project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Poisson Consulting Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with hmstimer","title":"Getting help with hmstimer","text":"Thanks using hmstimer! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/SUPPORT.html","id":"make-sure-its-new","dir":"","previous_headings":"","what":"Make sure its new","title":"Getting help with hmstimer","text":"opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with hmstimer","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Joe Thorley. Author, maintainer. Kirill Müller. Author. Nadine Hussein. Contributor. Poisson Consulting. Copyright holder, funder.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Thorley J, Müller K (2024). hmstimer: 'hms' Based Timer. R package version 0.3.0.9000, https://poissonconsulting.github.io/hmstimer/, https://github.com/poissonconsulting/hmstimer.","code":"@Manual{,   title = {hmstimer: 'hms' Based Timer},   author = {Joe Thorley and Kirill Müller},   year = {2024},   note = {R package version 0.3.0.9000,     https://poissonconsulting.github.io/hmstimer/},   url = {https://github.com/poissonconsulting/hmstimer}, }"},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"ssdtools-","dir":"","previous_headings":"","what":"hms Based Timer","title":"hms Based Timer","text":"hmstimer R package track elapsed clock time using hms::hms scalar. hmstimer originally developed time Bayesian model runs. used estimate long extremely fast code takes execute package code adds small time cost. Create start timer tmr_timer(start = TRUE). Get elapsed time tmr_elapsed(). title optional. Stop timer tmr_stop(). Restart timer tmr_start(). several options printing formatting including coercing hms object. running tmr_print() behaves differently. time block code complete can printed using with_timer().","code":"library(hmstimer)  tmr <- tmr_timer(start = TRUE) Sys.sleep(0.1) str(tmr) #>  'hms' num 00:00:00 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"\" #>  - attr(*, \"start\")= num 1.72e+09 hms::as_hms(tmr) #> 00:00:00 tmr <- tmr_timer(start = TRUE, title = \"my timer\")  Sys.sleep(0.1) tmr_elapsed(tmr) #> 00:00:00.106536  Sys.sleep(0.1) tmr_elapsed(tmr) #> 00:00:00.219374 tmr <- tmr_stop(tmr) tmr_elapsed(tmr) #> 00:00:00.227311  Sys.sleep(1) tmr_elapsed(tmr) #> 00:00:00.227311 tmr <- tmr_start(tmr) tmr_elapsed(tmr) #> 00:00:00.228075 Sys.sleep(0.1) tmr_elapsed(tmr) #> 00:00:00.338415 tmr <- tmr_stop(tmr) print(tmr) #> 00:00:00.352069 tmr_print(tmr) #> [1] \"00:00:00.352069 [my timer]\" tmr_format(tmr, digits = 5) #> [1] \"00:00:00.35207 [my timer]\" tmr <- tmr_start(tmr) tmr_print(tmr) #> [1] \"19:57:37 (+00:00:01 => 19:57:38) [my timer]\" with_timer({   Sys.sleep(0.1)   Sys.sleep(0.1)   1 + 1 }) #> 00:00:00.211 #> [1] 2"},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"hms Based Timer","text":"install latest release version CRAN. install latest development version r-universe. install latest development version GitHub","code":"install.packages(\"hmstimer\") install.packages(\"hmstimer\", repos = c(\"https://poissonconsulting.r-universe.dev\", \"https://cloud.r-project.org\")) # install.packages(\"pak\", repos = sprintf(\"https://r-lib.github.io/p/pak/stable/%s/%s/%s\", .Platform$pkgType, R.Version()$os, R.Version()$arch)) pak::pak(\"poissonconsulting/hmstimer\")"},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"contribution","dir":"","previous_headings":"","what":"Contribution","title":"hms Based Timer","text":"Please report issues. Pull requests always welcome.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"hms Based Timer","text":"Please note hmstimer project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hms_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"hms Timer — hms_timer","title":"hms Timer — hms_timer","text":"hms Timer hms::hms() scalar running attribute named start specifies system time timer started.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hms_timer.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"hms Timer — hms_timer","text":"elapsed time value scalar plus difference current system time system time timer started.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hms_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"hms Timer — hms_timer","text":"","code":"str(tmr_timer()) #>  'hms' num 00:00:00 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"\" str(tmr_timer(1.5, start = TRUE)) #>  'hms' num 00:00:01.5 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"\" #>  - attr(*, \"start\")= num 1.73e+09  x <- tmr_timer(1, start = TRUE) print(x) #> 00:00:01 Sys.sleep(0.1) print(x) #> 00:00:01 print(tmr_elapsed(x)) #> 00:00:01.102967 print(x) #> 00:00:01"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hmstimer-package.html","id":null,"dir":"Reference","previous_headings":"","what":"hmstimer: 'hms' Based Timer — hmstimer-package","title":"hmstimer: 'hms' Based Timer — hmstimer-package","text":"Tracks elapsed clock time using `hms::hms()` scalar. originally developed time Bayesian model runs. used estimate long extremely fast code takes execute package code adds small time cost.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hmstimer-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"hmstimer: 'hms' Based Timer — hmstimer-package","text":"Maintainer: Joe Thorley joe@poissonconsulting.ca (ORCID) Authors: Kirill Müller kirill@cynkra.com (ORCID) contributors: Nadine Hussein nadine@poissonconsulting.ca (ORCID) [contributor] Poisson Consulting [copyright holder, funder]","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"Local Timer — local_timer","title":"Local Timer — local_timer","text":"Called side effect providing message time required execute rest function.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Local Timer — local_timer","text":"","code":"local_timer(..., title = \"\", srcref = TRUE, .local_envir = rlang::caller_env())"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Local Timer — local_timer","text":"... dots future extensions must empty. title string title. srcref flag specifying whether print source reference. .local_envir environment use scoping.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Local Timer — local_timer","text":"","code":"fun <- function() {   local_timer()   Sys.sleep(0.1)   10 } fun() #> 00:00:00.101 [:] #> [1] 10"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/params.html","id":null,"dir":"Reference","previous_headings":"","what":"Parameter Descriptions — params","title":"Parameter Descriptions — params","text":"Default parameter descriptions may overridden individual functions.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parameter Descriptions — params","text":"... dots future extensions must empty. code line block R code. digits count number decimal places. print_title flag specifying whether print title. seconds non-negative numeric scalar initial number seconds. srcref flag specifying whether print source reference. start flag specifying whether start timer. title string title. value string title. x hms_timer(). .local_envir environment use scoping.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/params.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Parameter Descriptions — params","text":"flag non-missing logical scalar. string non-missing character scalar. count non-missing non-negative integer scalar double scalar fractional part.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":null,"dir":"Reference","previous_headings":"","what":"Ceiling hms Timer — tmr_ceiling","title":"Ceiling hms Timer — tmr_ceiling","text":"Rounds hms_timer() nearest second.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ceiling hms Timer — tmr_ceiling","text":"","code":"tmr_ceiling(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ceiling hms Timer — tmr_ceiling","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ceiling hms Timer — tmr_ceiling","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Ceiling hms Timer — tmr_ceiling","text":"","code":"tmr_ceiling(tmr_timer(18.9)) #> 00:00:19 tmr_ceiling(tmr_timer(122.1)) #> 00:02:03"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":null,"dir":"Reference","previous_headings":"","what":"Elapsed Time hms Timer — tmr_elapsed","title":"Elapsed Time hms Timer — tmr_elapsed","text":"Returns elapsed time hms_timer() hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elapsed Time hms Timer — tmr_elapsed","text":"","code":"tmr_elapsed(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elapsed Time hms Timer — tmr_elapsed","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elapsed Time hms Timer — tmr_elapsed","text":"hms_timer() elapsed time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Elapsed Time hms Timer — tmr_elapsed","text":"elapsed time value scalar plus difference current system time system time timer started. original hms_timer() running new hms_timer() assigned attribute named start current system time.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Elapsed Time hms Timer — tmr_elapsed","text":"","code":"tmr <- tmr_start(tmr_timer()) print(tmr_elapsed(tmr)) #> 00:00:00.000525 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.012148 tmr <- tmr_stop(tmr) print(tmr_elapsed(tmr)) #> 00:00:00.013422 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.013422"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":null,"dir":"Reference","previous_headings":"","what":"Floor hms Timer — tmr_floor","title":"Floor hms Timer — tmr_floor","text":"Rounds hms_timer() nearest second.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Floor hms Timer — tmr_floor","text":"","code":"tmr_floor(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Floor hms Timer — tmr_floor","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Floor hms Timer — tmr_floor","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Floor hms Timer — tmr_floor","text":"","code":"tmr_floor(tmr_timer(18.9)) #> 00:00:18 tmr_floor(tmr_timer(122.1)) #> 00:02:02"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":null,"dir":"Reference","previous_headings":"","what":"Format hms Timer — tmr_format","title":"Format hms Timer — tmr_format","text":"Converts hms_timer() string clock time rounding number digits.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format hms Timer — tmr_format","text":"","code":"tmr_format(x, digits = 3, ..., print_title = TRUE)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format hms Timer — tmr_format","text":"x hms_timer(). digits count number decimal places. ... dots future extensions must empty. print_title flag specifying whether print title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format hms Timer — tmr_format","text":"character string.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format hms Timer — tmr_format","text":"Negative values digit permitted.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format hms Timer — tmr_format","text":"","code":"tmr_format(tmr_timer(61.66)) #> [1] \"00:01:01.660\" tmr_format(tmr_timer(61.66), digits = 0) #> [1] \"00:01:02\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":null,"dir":"Reference","previous_headings":"","what":"Is hms Timer Started — tmr_is_started","title":"Is hms Timer Started — tmr_is_started","text":"Tests hms_timer() started (indicated presence attribute named start).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is hms Timer Started — tmr_is_started","text":"","code":"tmr_is_started(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is hms Timer Started — tmr_is_started","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is hms Timer Started — tmr_is_started","text":"flag (TRUE FALSE).","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Is hms Timer Started — tmr_is_started","text":"","code":"tmr <- tmr_timer(start = TRUE) print(tmr_is_started(tmr)) #> [1] TRUE tmr <- tmr_stop(tmr) print(tmr_is_started(tmr)) #> [1] FALSE"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":null,"dir":"Reference","previous_headings":"","what":"Is hms Timer Stopped — tmr_is_stopped","title":"Is hms Timer Stopped — tmr_is_stopped","text":"Tests hms_timer() stopped (indicated absence attribute named start).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is hms Timer Stopped — tmr_is_stopped","text":"","code":"tmr_is_stopped(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is hms Timer Stopped — tmr_is_stopped","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is hms Timer Stopped — tmr_is_stopped","text":"flag.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Is hms Timer Stopped — tmr_is_stopped","text":"","code":"tmr <- tmr_timer(start = TRUE) print(tmr_is_stopped(tmr)) #> [1] FALSE tmr <- tmr_stop(tmr) print(tmr_is_stopped(tmr)) #> [1] TRUE"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":null,"dir":"Reference","previous_headings":"","what":"Is hms Timer Title — tmr_is_titled","title":"Is hms Timer Title — tmr_is_titled","text":"Tests hms_timer() title (indicated presence attribute named start).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is hms Timer Title — tmr_is_titled","text":"","code":"tmr_is_titled(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is hms Timer Title — tmr_is_titled","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is hms Timer Title — tmr_is_titled","text":"flag (TRUE FALSE).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Is hms Timer Title — tmr_is_titled","text":"","code":"tmr_is_titled(tmr_timer()) #> [1] FALSE tmr_is_titled(tmr_timer(title = \"my timer\")) #> [1] TRUE"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":null,"dir":"Reference","previous_headings":"","what":"Print hms Timer — tmr_print","title":"Print hms Timer — tmr_print","text":"Returns elapsed time hms_timer() system time timer started current system time hms time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print hms Timer — tmr_print","text":"","code":"tmr_print(x, ..., print_title = TRUE)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print hms Timer — tmr_print","text":"x hms_timer(). ... dots future extensions must empty. print_title flag specifying whether print title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print hms Timer — tmr_print","text":"character string.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Print hms Timer — tmr_print","text":"elapsed time value scalar plus difference current system time system time timer started.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Print hms Timer — tmr_print","text":"","code":"x <- tmr_start(tmr_timer()) tmr_print(x) #> [1] \"15:59:34 (+00:00:01 => 15:59:35)\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset hms Timer — tmr_reset","title":"Reset hms Timer — tmr_reset","text":"Resets hms_timer() creating new one.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset hms Timer — tmr_reset","text":"","code":"tmr_reset(x, seconds = 0)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset hms Timer — tmr_reset","text":"x hms_timer(). seconds non-negative numeric scalar initial number seconds.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset hms Timer — tmr_reset","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reset hms Timer — tmr_reset","text":"","code":"tmr <- tmr_timer(10) print(tmr) #> 00:00:10 tmr_reset(tmr) #> 00:00:00"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":null,"dir":"Reference","previous_headings":"","what":"Round hms Timer — tmr_round","title":"Round hms Timer — tmr_round","text":"Rounds hms_timer() updating elapsed time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Round hms Timer — tmr_round","text":"","code":"tmr_round(x, digits = 0)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Round hms Timer — tmr_round","text":"x hms_timer(). digits count number decimal places.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Round hms Timer — tmr_round","text":"hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Round hms Timer — tmr_round","text":"Negative values digit permitted.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Round hms Timer — tmr_round","text":"","code":"tmr_round(tmr_timer(18.9)) #> 00:00:19 tmr_round(tmr_timer(18.9), 1) #> 00:00:18.9 tmr_round(tmr_timer(18.9), -1) #> 00:00:20 tmr_round(tmr_timer(121), -2) # 121 is rounded to 100 seconds #> 00:01:40"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":null,"dir":"Reference","previous_headings":"","what":"Start hms Timer — tmr_start","title":"Start hms Timer — tmr_start","text":"Starts hms_timer() adding attribute named start current system time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Start hms Timer — tmr_start","text":"","code":"tmr_start(x, ..., title = NULL)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Start hms Timer — tmr_start","text":"x hms_timer(). ... dots future extensions must empty. title string title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Start hms Timer — tmr_start","text":"started hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Start hms Timer — tmr_start","text":"hms_timer() already started, function simply issues warning returns original object.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Start hms Timer — tmr_start","text":"","code":"tmr <- tmr_start(tmr_timer()) print(tmr_elapsed(tmr)) #> 00:00:00.000537 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.012208"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":null,"dir":"Reference","previous_headings":"","what":"Stop hms Timer — tmr_stop","title":"Stop hms Timer — tmr_stop","text":"Stops hms_timer() updating elapsed time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stop hms Timer — tmr_stop","text":"","code":"tmr_stop(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stop hms Timer — tmr_stop","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stop hms Timer — tmr_stop","text":"stopped hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Stop hms Timer — tmr_stop","text":"hms_timer() already stopped, function simply issues warning returns original object.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Stop hms Timer — tmr_stop","text":"","code":"tmr <- tmr_stop(tmr_timer(start = TRUE)) print(tmr_elapsed(tmr)) #> 00:00:00.000028 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.000028"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"Create hms Timer — tmr_timer","title":"Create hms Timer — tmr_timer","text":"Creates hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create hms Timer — tmr_timer","text":"","code":"tmr_timer(seconds = 0, start = FALSE, ..., title = \"\")"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create hms Timer — tmr_timer","text":"seconds non-negative numeric scalar initial number seconds. start flag specifying whether start timer. ... dots future extensions must empty. title string title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create hms Timer — tmr_timer","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create hms Timer — tmr_timer","text":"","code":"tmr_timer() #> 00:00:00 tmr_timer(1, start = TRUE, title = \"my timer\") #> 00:00:01 class(tmr_timer(2)) #> [1] \"hms\"      \"difftime\" str(tmr_timer(2, start = TRUE, title = \"a timer\")) #>  'hms' num 00:00:02 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"a timer\" #>  - attr(*, \"start\")= num 1.73e+09"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":null,"dir":"Reference","previous_headings":"","what":"Set Title hms Timer — tmr_title<-","title":"Set Title hms Timer — tmr_title<-","text":"Sets title hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set Title hms Timer — tmr_title<-","text":"","code":"tmr_title(x) <- value"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set Title hms Timer — tmr_title<-","text":"x hms_timer(). value string title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set Title hms Timer — tmr_title<-","text":"copy hms_timer() new title.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set Title hms Timer — tmr_title<-","text":"","code":"tmr <- tmr_timer(title = \"A title\") tmr_print(tmr) #> [1] \"00:00:00 [A title]\" tmr_title(tmr) <- \"A different title\" tmr_print(tmr) #> [1] \"00:00:00 [A different title]\" tmr_title(tmr) <- NULL tmr_print(tmr) #> [1] \"00:00:00\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Title hms Timer — tmr_title","title":"Get Title hms Timer — tmr_title","text":"Returns flag (character vector) title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Title hms Timer — tmr_title","text":"","code":"tmr_title(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Title hms Timer — tmr_title","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Title hms Timer — tmr_title","text":"flag title.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Title hms Timer — tmr_title","text":"","code":"tmr_title(tmr_timer()) #> [1] \"\" tmr_title(tmr_timer(title = \"\")) #> [1] \"\" tmr_title(tmr_timer(title = \"A Title\")) #> [1] \"A Title\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"With Timer — with_timer","title":"With Timer — with_timer","text":"Timer","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"With Timer — with_timer","text":"","code":"with_timer(code, ..., title = FALSE, srcref = FALSE)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"With Timer — with_timer","text":"code line block R code. ... dots future extensions must empty. title flag specifying whether add title based code. srcref flag specifying whether print source reference.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"With Timer — with_timer","text":"result executing code.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"With Timer — with_timer","text":"","code":"fun <- function() {   Sys.sleep(0.1)   10 } with_timer(fun()) #> 00:00:00.100 #> [1] 10  with_timer({   for (i in 1:2) {     Sys.sleep(0.1)   }   20 }) #> 00:00:00.200 #> [1] 20"},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-0309000","dir":"Changelog","previous_headings":"","what":"hmstimer 0.3.0.9000","title":"hmstimer 0.3.0.9000","text":"previous version.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-030","dir":"Changelog","previous_headings":"","what":"hmstimer 0.3.0","title":"hmstimer 0.3.0","text":"CRAN release: 2024-08-19","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"features-0-3-0","dir":"Changelog","previous_headings":"","what":"Features","title":"hmstimer 0.3.0","text":"tmr_title() tmr_title<- tmr_is_titled() tmr_print(print_title = TRUE) tmr_format(print_title = TRUE) local_timer() with_timer()","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-021","dir":"Changelog","previous_headings":"","what":"hmstimer 0.2.1","title":"hmstimer 0.2.1","text":"CRAN release: 2022-09-20 Fix CRAN tests.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-020","dir":"Changelog","previous_headings":"","what":"hmstimer 0.2.0","title":"hmstimer 0.2.0","text":"CRAN release: 2022-08-26 Added tmr_print().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-011","dir":"Changelog","previous_headings":"","what":"hmstimer 0.1.1","title":"hmstimer 0.1.1","text":"CRAN release: 2021-09-20 Removed deprecated start = FALSE argument tmr_reset().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-010","dir":"Changelog","previous_headings":"","what":"hmstimer 0.1.0","title":"hmstimer 0.1.0","text":"CRAN release: 2020-07-09 Hard deprecated start = FALSE argument tmr_reset(). Added tmr_format(). Added tmr_round(), tmr_floor() tmr_ceiling(). Switched tidyverse style error warning messages.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-002","dir":"Changelog","previous_headings":"","what":"hmstimer 0.0.2","title":"hmstimer 0.0.2","text":"CRAN release: 2019-07-24 Replaced hms::.hms hms::as_hms hms 0.5.0.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-001","dir":"Changelog","previous_headings":"","what":"hmstimer 0.0.1","title":"hmstimer 0.0.1","text":"CRAN release: 2019-05-24 Added NEWS.md file track changes package.","code":""}]
+[{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"enforcement","dir":"","previous_headings":"","what":"Enforcement","title":"Contributor Covenant Code of Conduct","text":"Instances abusive, harassing, otherwise unacceptable behavior may reported community leaders responsible enforcement codeofconduct@posit.co. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CODE_OF_CONDUCT.html","id":"attribution","dir":"","previous_headings":"","what":"Attribution","title":"Contributor Covenant Code of Conduct","text":"Code Conduct adapted Contributor Covenant, version 2.1, available https://www.contributor-covenant.org/version/2/1/code_of_conduct.html. Community Impact Guidelines inspired [Mozilla’s code conduct enforcement ladder][https://github.com/mozilla/inclusion]. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to hmstimer","title":"Contributing to hmstimer","text":"outlines propose change hmstimer.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to hmstimer","text":"can fix typos, spelling mistakes, grammatical errors documentation directly using GitHub web interface, long changes made source file. generally means ’ll need edit roxygen2 comments .R, .Rd file. can find .R file generates .Rd reading comment first line.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to hmstimer","text":"want make bigger change, ’s good idea first file issue make sure someone team agrees ’s needed. ’ve found bug, please file issue illustrates bug minimal reprex (also help write unit test, needed).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to hmstimer","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"\", fork = TRUE). Install development dependences devtools::install_dev_deps(), make sure package passes R CMD check running devtools::check(). R CMD check doesn’t pass cleanly, ’s good idea ask help continuing. Create Git branch pull request (PR). recommend using usethis::pr_init(\"brief-description--change\"). Make changes, commit git, create PR running usethis::pr_push(), following prompts browser. title PR briefly describe change. body PR contain Fixes #issue-number. Begin commit merge messages - indicate user facing changes included NEWS.md. use fledge automatically generate NEWS.md file.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to hmstimer","text":"New code follow tidyverse style guide. can use styler package apply styles, please don’t restyle code nothing PR. use roxygen2, Markdown syntax, documentation. use testthat unit tests. Contributions test cases included easier accept.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to hmstimer","text":"Please note hmstimer project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 Poisson Consulting Permission hereby granted, free charge, person obtaining copy software associated documentation files (“Software”), deal Software without restriction, including without limitation rights use, copy, modify, merge, publish, distribute, sublicense, /sell copies Software, permit persons Software furnished , subject following conditions: copyright notice permission notice shall included copies substantial portions Software. SOFTWARE PROVIDED “”, WITHOUT WARRANTY KIND, EXPRESS IMPLIED, INCLUDING LIMITED WARRANTIES MERCHANTABILITY, FITNESS PARTICULAR PURPOSE NONINFRINGEMENT. EVENT SHALL AUTHORS COPYRIGHT HOLDERS LIABLE CLAIM, DAMAGES LIABILITY, WHETHER ACTION CONTRACT, TORT OTHERWISE, ARISING , CONNECTION SOFTWARE USE DEALINGS SOFTWARE.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with hmstimer","title":"Getting help with hmstimer","text":"Thanks using hmstimer! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/SUPPORT.html","id":"make-sure-its-new","dir":"","previous_headings":"","what":"Make sure its new","title":"Getting help with hmstimer","text":"opening new issue, sure search issues pull requests make sure bug hasn’t reported /already fixed development version. default, search pre-populated :issue :open. can edit qualifiers (e.g. :pr, :closed) needed. example, ’d simply remove :open search issues repo, open closed.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with hmstimer","text":"Start making minimal reproducible example using reprex package. haven’t heard used reprex , ’re treat! Seriously, reprex make R-question-asking endeavors easier (pretty insane ROI five ten minutes ’ll take learn ’s ). additional reprex pointers, check Get help! section tidyverse site.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Joe Thorley. Author, maintainer. Kirill Müller. Author. Nadine Hussein. Contributor. Poisson Consulting. Copyright holder, funder.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Thorley J, Müller K (2024). hmstimer: 'hms' Based Timer. R package version 0.3.0.9000, https://poissonconsulting.github.io/hmstimer/, https://github.com/poissonconsulting/hmstimer.","code":"@Manual{,   title = {hmstimer: 'hms' Based Timer},   author = {Joe Thorley and Kirill Müller},   year = {2024},   note = {R package version 0.3.0.9000,     https://poissonconsulting.github.io/hmstimer/},   url = {https://github.com/poissonconsulting/hmstimer}, }"},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"ssdtools-","dir":"","previous_headings":"","what":"hms Based Timer","title":"hms Based Timer","text":"hmstimer R package track elapsed clock time using hms::hms scalar. hmstimer originally developed time Bayesian model runs. used estimate long extremely fast code takes execute package code adds small time cost. Create start timer tmr_timer(start = TRUE). Get elapsed time tmr_elapsed(). title optional. Stop timer tmr_stop(). Restart timer tmr_start(). several options printing formatting including coercing hms object. running tmr_print() behaves differently. time block code complete can printed using with_timer().","code":"library(hmstimer)  tmr <- tmr_timer(start = TRUE) Sys.sleep(0.1) str(tmr) #>  'hms' num 00:00:00 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"\" #>  - attr(*, \"start\")= num 1.72e+09 hms::as_hms(tmr) #> 00:00:00 tmr <- tmr_timer(start = TRUE, title = \"my timer\")  Sys.sleep(0.1) tmr_elapsed(tmr) #> 00:00:00.106536  Sys.sleep(0.1) tmr_elapsed(tmr) #> 00:00:00.219374 tmr <- tmr_stop(tmr) tmr_elapsed(tmr) #> 00:00:00.227311  Sys.sleep(1) tmr_elapsed(tmr) #> 00:00:00.227311 tmr <- tmr_start(tmr) tmr_elapsed(tmr) #> 00:00:00.228075 Sys.sleep(0.1) tmr_elapsed(tmr) #> 00:00:00.338415 tmr <- tmr_stop(tmr) print(tmr) #> 00:00:00.352069 tmr_print(tmr) #> [1] \"00:00:00.352069 [my timer]\" tmr_format(tmr, digits = 5) #> [1] \"00:00:00.35207 [my timer]\" tmr <- tmr_start(tmr) tmr_print(tmr) #> [1] \"19:57:37 (+00:00:01 => 19:57:38) [my timer]\" with_timer({   Sys.sleep(0.1)   Sys.sleep(0.1)   1 + 1 }) #> 00:00:00.211 #> [1] 2"},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"hms Based Timer","text":"install latest release version CRAN. install latest development version r-universe. install latest development version GitHub","code":"install.packages(\"hmstimer\") install.packages(\"hmstimer\", repos = c(\"https://poissonconsulting.r-universe.dev\", \"https://cloud.r-project.org\")) # install.packages(\"pak\", repos = sprintf(\"https://r-lib.github.io/p/pak/stable/%s/%s/%s\", .Platform$pkgType, R.Version()$os, R.Version()$arch)) pak::pak(\"poissonconsulting/hmstimer\")"},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"contribution","dir":"","previous_headings":"","what":"Contribution","title":"hms Based Timer","text":"Please report issues. Pull requests always welcome.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/index.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"hms Based Timer","text":"Please note hmstimer project released Contributor Code Conduct. contributing project, agree abide terms.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hms_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"hms Timer — hms_timer","title":"hms Timer — hms_timer","text":"hms Timer hms::hms() scalar running attribute named start specifies system time timer started.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hms_timer.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"hms Timer — hms_timer","text":"elapsed time value scalar plus difference current system time system time timer started.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hms_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"hms Timer — hms_timer","text":"","code":"str(tmr_timer()) #>  'hms' num 00:00:00 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"\" str(tmr_timer(1.5, start = TRUE)) #>  'hms' num 00:00:01.5 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"\" #>  - attr(*, \"start\")= num 1.73e+09  x <- tmr_timer(1, start = TRUE) print(x) #> 00:00:01 Sys.sleep(0.1) print(x) #> 00:00:01 print(tmr_elapsed(x)) #> 00:00:01.103028 print(x) #> 00:00:01"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hmstimer-package.html","id":null,"dir":"Reference","previous_headings":"","what":"hmstimer: 'hms' Based Timer — hmstimer-package","title":"hmstimer: 'hms' Based Timer — hmstimer-package","text":"Tracks elapsed clock time using `hms::hms()` scalar. originally developed time Bayesian model runs. used estimate long extremely fast code takes execute package code adds small time cost.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/hmstimer-package.html","id":"author","dir":"Reference","previous_headings":"","what":"Author","title":"hmstimer: 'hms' Based Timer — hmstimer-package","text":"Maintainer: Joe Thorley joe@poissonconsulting.ca (ORCID) Authors: Kirill Müller kirill@cynkra.com (ORCID) contributors: Nadine Hussein nadine@poissonconsulting.ca (ORCID) [contributor] Poisson Consulting [copyright holder, funder]","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"Local Timer — local_timer","title":"Local Timer — local_timer","text":"Called side effect providing message time required execute rest function.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Local Timer — local_timer","text":"","code":"local_timer(..., title = \"\", srcref = TRUE, .local_envir = rlang::caller_env())"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Local Timer — local_timer","text":"... dots future extensions must empty. title string title. srcref flag specifying whether print source reference. .local_envir environment use scoping.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/local_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Local Timer — local_timer","text":"","code":"fun <- function() {   local_timer()   Sys.sleep(0.1)   10 } fun() #> 00:00:00.101 [:] #> [1] 10"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/params.html","id":null,"dir":"Reference","previous_headings":"","what":"Parameter Descriptions — params","title":"Parameter Descriptions — params","text":"Default parameter descriptions may overridden individual functions.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/params.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Parameter Descriptions — params","text":"... dots future extensions must empty. code line block R code. digits count number decimal places. print_title flag specifying whether print title. seconds non-negative numeric scalar initial number seconds. srcref flag specifying whether print source reference. start flag specifying whether start timer. title string title. value string title. x hms_timer(). .local_envir environment use scoping.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/params.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Parameter Descriptions — params","text":"flag non-missing logical scalar. string non-missing character scalar. count non-missing non-negative integer scalar double scalar fractional part.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":null,"dir":"Reference","previous_headings":"","what":"Ceiling hms Timer — tmr_ceiling","title":"Ceiling hms Timer — tmr_ceiling","text":"Rounds hms_timer() nearest second.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Ceiling hms Timer — tmr_ceiling","text":"","code":"tmr_ceiling(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Ceiling hms Timer — tmr_ceiling","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Ceiling hms Timer — tmr_ceiling","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_ceiling.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Ceiling hms Timer — tmr_ceiling","text":"","code":"tmr_ceiling(tmr_timer(18.9)) #> 00:00:19 tmr_ceiling(tmr_timer(122.1)) #> 00:02:03"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":null,"dir":"Reference","previous_headings":"","what":"Elapsed Time hms Timer — tmr_elapsed","title":"Elapsed Time hms Timer — tmr_elapsed","text":"Returns elapsed time hms_timer() hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Elapsed Time hms Timer — tmr_elapsed","text":"","code":"tmr_elapsed(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Elapsed Time hms Timer — tmr_elapsed","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Elapsed Time hms Timer — tmr_elapsed","text":"hms_timer() elapsed time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Elapsed Time hms Timer — tmr_elapsed","text":"elapsed time value scalar plus difference current system time system time timer started. original hms_timer() running new hms_timer() assigned attribute named start current system time.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_elapsed.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Elapsed Time hms Timer — tmr_elapsed","text":"","code":"tmr <- tmr_start(tmr_timer()) print(tmr_elapsed(tmr)) #> 00:00:00.000493 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.012035 tmr <- tmr_stop(tmr) print(tmr_elapsed(tmr)) #> 00:00:00.013096 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.013096"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":null,"dir":"Reference","previous_headings":"","what":"Floor hms Timer — tmr_floor","title":"Floor hms Timer — tmr_floor","text":"Rounds hms_timer() nearest second.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Floor hms Timer — tmr_floor","text":"","code":"tmr_floor(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Floor hms Timer — tmr_floor","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Floor hms Timer — tmr_floor","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_floor.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Floor hms Timer — tmr_floor","text":"","code":"tmr_floor(tmr_timer(18.9)) #> 00:00:18 tmr_floor(tmr_timer(122.1)) #> 00:02:02"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":null,"dir":"Reference","previous_headings":"","what":"Format hms Timer — tmr_format","title":"Format hms Timer — tmr_format","text":"Converts hms_timer() string clock time rounding number digits.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Format hms Timer — tmr_format","text":"","code":"tmr_format(x, digits = 3, ..., print_title = TRUE)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Format hms Timer — tmr_format","text":"x hms_timer(). digits count number decimal places. ... dots future extensions must empty. print_title flag specifying whether print title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Format hms Timer — tmr_format","text":"character string.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Format hms Timer — tmr_format","text":"Negative values digit permitted.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_format.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Format hms Timer — tmr_format","text":"","code":"tmr_format(tmr_timer(61.66)) #> [1] \"00:01:01.660\" tmr_format(tmr_timer(61.66), digits = 0) #> [1] \"00:01:02\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":null,"dir":"Reference","previous_headings":"","what":"Is hms Timer Started — tmr_is_started","title":"Is hms Timer Started — tmr_is_started","text":"Tests hms_timer() started (indicated presence attribute named start).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is hms Timer Started — tmr_is_started","text":"","code":"tmr_is_started(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is hms Timer Started — tmr_is_started","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is hms Timer Started — tmr_is_started","text":"flag (TRUE FALSE).","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_started.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Is hms Timer Started — tmr_is_started","text":"","code":"tmr <- tmr_timer(start = TRUE) print(tmr_is_started(tmr)) #> [1] TRUE tmr <- tmr_stop(tmr) print(tmr_is_started(tmr)) #> [1] FALSE"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":null,"dir":"Reference","previous_headings":"","what":"Is hms Timer Stopped — tmr_is_stopped","title":"Is hms Timer Stopped — tmr_is_stopped","text":"Tests hms_timer() stopped (indicated absence attribute named start).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is hms Timer Stopped — tmr_is_stopped","text":"","code":"tmr_is_stopped(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is hms Timer Stopped — tmr_is_stopped","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is hms Timer Stopped — tmr_is_stopped","text":"flag.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_stopped.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Is hms Timer Stopped — tmr_is_stopped","text":"","code":"tmr <- tmr_timer(start = TRUE) print(tmr_is_stopped(tmr)) #> [1] FALSE tmr <- tmr_stop(tmr) print(tmr_is_stopped(tmr)) #> [1] TRUE"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":null,"dir":"Reference","previous_headings":"","what":"Is hms Timer Title — tmr_is_titled","title":"Is hms Timer Title — tmr_is_titled","text":"Tests hms_timer() title (indicated presence attribute named start).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Is hms Timer Title — tmr_is_titled","text":"","code":"tmr_is_titled(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Is hms Timer Title — tmr_is_titled","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Is hms Timer Title — tmr_is_titled","text":"flag (TRUE FALSE).","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_is_titled.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Is hms Timer Title — tmr_is_titled","text":"","code":"tmr_is_titled(tmr_timer()) #> [1] FALSE tmr_is_titled(tmr_timer(title = \"my timer\")) #> [1] TRUE"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":null,"dir":"Reference","previous_headings":"","what":"Print hms Timer — tmr_print","title":"Print hms Timer — tmr_print","text":"Returns elapsed time hms_timer() system time timer started current system time hms time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Print hms Timer — tmr_print","text":"","code":"tmr_print(x, ..., print_title = TRUE)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Print hms Timer — tmr_print","text":"x hms_timer(). ... dots future extensions must empty. print_title flag specifying whether print title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Print hms Timer — tmr_print","text":"character string.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Print hms Timer — tmr_print","text":"elapsed time value scalar plus difference current system time system time timer started.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_print.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Print hms Timer — tmr_print","text":"","code":"x <- tmr_start(tmr_timer()) tmr_print(x) #> [1] \"18:46:50 (+00:00:01 => 18:46:51)\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":null,"dir":"Reference","previous_headings":"","what":"Reset hms Timer — tmr_reset","title":"Reset hms Timer — tmr_reset","text":"Resets hms_timer() creating new one.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Reset hms Timer — tmr_reset","text":"","code":"tmr_reset(x, seconds = 0)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Reset hms Timer — tmr_reset","text":"x hms_timer(). seconds non-negative numeric scalar initial number seconds.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Reset hms Timer — tmr_reset","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_reset.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Reset hms Timer — tmr_reset","text":"","code":"tmr <- tmr_timer(10) print(tmr) #> 00:00:10 tmr_reset(tmr) #> 00:00:00"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":null,"dir":"Reference","previous_headings":"","what":"Round hms Timer — tmr_round","title":"Round hms Timer — tmr_round","text":"Rounds hms_timer() updating elapsed time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Round hms Timer — tmr_round","text":"","code":"tmr_round(x, digits = 0)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Round hms Timer — tmr_round","text":"x hms_timer(). digits count number decimal places.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Round hms Timer — tmr_round","text":"hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Round hms Timer — tmr_round","text":"Negative values digit permitted.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_round.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Round hms Timer — tmr_round","text":"","code":"tmr_round(tmr_timer(18.9)) #> 00:00:19 tmr_round(tmr_timer(18.9), 1) #> 00:00:18.9 tmr_round(tmr_timer(18.9), -1) #> 00:00:20 tmr_round(tmr_timer(121), -2) # 121 is rounded to 100 seconds #> 00:01:40"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":null,"dir":"Reference","previous_headings":"","what":"Start hms Timer — tmr_start","title":"Start hms Timer — tmr_start","text":"Starts hms_timer() adding attribute named start current system time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Start hms Timer — tmr_start","text":"","code":"tmr_start(x, ..., title = NULL)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Start hms Timer — tmr_start","text":"x hms_timer(). ... dots future extensions must empty. title string title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Start hms Timer — tmr_start","text":"started hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Start hms Timer — tmr_start","text":"hms_timer() already started, function simply issues warning returns original object.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_start.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Start hms Timer — tmr_start","text":"","code":"tmr <- tmr_start(tmr_timer()) print(tmr_elapsed(tmr)) #> 00:00:00.000536 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.012168"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":null,"dir":"Reference","previous_headings":"","what":"Stop hms Timer — tmr_stop","title":"Stop hms Timer — tmr_stop","text":"Stops hms_timer() updating elapsed time.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Stop hms Timer — tmr_stop","text":"","code":"tmr_stop(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Stop hms Timer — tmr_stop","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Stop hms Timer — tmr_stop","text":"stopped hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Stop hms Timer — tmr_stop","text":"hms_timer() already stopped, function simply issues warning returns original object.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_stop.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Stop hms Timer — tmr_stop","text":"","code":"tmr <- tmr_stop(tmr_timer(start = TRUE)) print(tmr_elapsed(tmr)) #> 00:00:00.000025 Sys.sleep(0.01) print(tmr_elapsed(tmr)) #> 00:00:00.000025"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"Create hms Timer — tmr_timer","title":"Create hms Timer — tmr_timer","text":"Creates hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create hms Timer — tmr_timer","text":"","code":"tmr_timer(seconds = 0, start = FALSE, ..., title = \"\")"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create hms Timer — tmr_timer","text":"seconds non-negative numeric scalar initial number seconds. start flag specifying whether start timer. ... dots future extensions must empty. title string title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create hms Timer — tmr_timer","text":"hms_timer().","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Create hms Timer — tmr_timer","text":"","code":"tmr_timer() #> 00:00:00 tmr_timer(1, start = TRUE, title = \"my timer\") #> 00:00:01 class(tmr_timer(2)) #> [1] \"hms\"      \"difftime\" str(tmr_timer(2, start = TRUE, title = \"a timer\")) #>  'hms' num 00:00:02 #>  - attr(*, \"units\")= chr \"secs\" #>  - attr(*, \"title\")= chr \"a timer\" #>  - attr(*, \"start\")= num 1.73e+09"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":null,"dir":"Reference","previous_headings":"","what":"Set Title hms Timer — tmr_title<-","title":"Set Title hms Timer — tmr_title<-","text":"Sets title hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Set Title hms Timer — tmr_title<-","text":"","code":"tmr_title(x) <- value"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Set Title hms Timer — tmr_title<-","text":"x hms_timer(). value string title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Set Title hms Timer — tmr_title<-","text":"copy hms_timer() new title.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title-set.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Set Title hms Timer — tmr_title<-","text":"","code":"tmr <- tmr_timer(title = \"A title\") tmr_print(tmr) #> [1] \"00:00:00 [A title]\" tmr_title(tmr) <- \"A different title\" tmr_print(tmr) #> [1] \"00:00:00 [A different title]\" tmr_title(tmr) <- NULL tmr_print(tmr) #> [1] \"00:00:00\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":null,"dir":"Reference","previous_headings":"","what":"Get Title hms Timer — tmr_title","title":"Get Title hms Timer — tmr_title","text":"Returns flag (character vector) title.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Get Title hms Timer — tmr_title","text":"","code":"tmr_title(x)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Get Title hms Timer — tmr_title","text":"x hms_timer().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Get Title hms Timer — tmr_title","text":"flag title.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/tmr_title.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Get Title hms Timer — tmr_title","text":"","code":"tmr_title(tmr_timer()) #> [1] \"\" tmr_title(tmr_timer(title = \"\")) #> [1] \"\" tmr_title(tmr_timer(title = \"A Title\")) #> [1] \"A Title\""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":null,"dir":"Reference","previous_headings":"","what":"With Timer — with_timer","title":"With Timer — with_timer","text":"Timer","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"With Timer — with_timer","text":"","code":"with_timer(code, ..., title = FALSE, srcref = FALSE)"},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"With Timer — with_timer","text":"code line block R code. ... dots future extensions must empty. title flag specifying whether add title based code. srcref flag specifying whether print source reference.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"With Timer — with_timer","text":"result executing code.","code":""},{"path":[]},{"path":"https://poissonconsulting.github.io/hmstimer/reference/with_timer.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"With Timer — with_timer","text":"","code":"fun <- function() {   Sys.sleep(0.1)   10 } with_timer(fun()) #> 00:00:00.100 #> [1] 10  with_timer({   for (i in 1:2) {     Sys.sleep(0.1)   }   20 }) #> 00:00:00.200 #> [1] 20"},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-0309000","dir":"Changelog","previous_headings":"","what":"hmstimer 0.3.0.9000","title":"hmstimer 0.3.0.9000","text":"previous version.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-030","dir":"Changelog","previous_headings":"","what":"hmstimer 0.3.0","title":"hmstimer 0.3.0","text":"CRAN release: 2024-08-19","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"features-0-3-0","dir":"Changelog","previous_headings":"","what":"Features","title":"hmstimer 0.3.0","text":"tmr_title() tmr_title<- tmr_is_titled() tmr_print(print_title = TRUE) tmr_format(print_title = TRUE) local_timer() with_timer()","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-021","dir":"Changelog","previous_headings":"","what":"hmstimer 0.2.1","title":"hmstimer 0.2.1","text":"CRAN release: 2022-09-20 Fix CRAN tests.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-020","dir":"Changelog","previous_headings":"","what":"hmstimer 0.2.0","title":"hmstimer 0.2.0","text":"CRAN release: 2022-08-26 Added tmr_print().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-011","dir":"Changelog","previous_headings":"","what":"hmstimer 0.1.1","title":"hmstimer 0.1.1","text":"CRAN release: 2021-09-20 Removed deprecated start = FALSE argument tmr_reset().","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-010","dir":"Changelog","previous_headings":"","what":"hmstimer 0.1.0","title":"hmstimer 0.1.0","text":"CRAN release: 2020-07-09 Hard deprecated start = FALSE argument tmr_reset(). Added tmr_format(). Added tmr_round(), tmr_floor() tmr_ceiling(). Switched tidyverse style error warning messages.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-002","dir":"Changelog","previous_headings":"","what":"hmstimer 0.0.2","title":"hmstimer 0.0.2","text":"CRAN release: 2019-07-24 Replaced hms::.hms hms::as_hms hms 0.5.0.","code":""},{"path":"https://poissonconsulting.github.io/hmstimer/news/index.html","id":"hmstimer-001","dir":"Changelog","previous_headings":"","what":"hmstimer 0.0.1","title":"hmstimer 0.0.1","text":"CRAN release: 2019-05-24 Added NEWS.md file track changes package.","code":""}]