diff --git a/apple-touch-icon-120x120.png b/apple-touch-icon-120x120.png index 0a28fc8..a67cc34 100644 Binary files a/apple-touch-icon-120x120.png and b/apple-touch-icon-120x120.png differ diff --git a/apple-touch-icon-152x152.png b/apple-touch-icon-152x152.png index f2daf89..5f723c1 100644 Binary files a/apple-touch-icon-152x152.png and b/apple-touch-icon-152x152.png differ diff --git a/apple-touch-icon-180x180.png b/apple-touch-icon-180x180.png index 280075a..d499071 100644 Binary files a/apple-touch-icon-180x180.png and b/apple-touch-icon-180x180.png differ diff --git a/apple-touch-icon-60x60.png b/apple-touch-icon-60x60.png index 3f6ad9f..37c44fe 100644 Binary files a/apple-touch-icon-60x60.png and b/apple-touch-icon-60x60.png differ diff --git a/apple-touch-icon-76x76.png b/apple-touch-icon-76x76.png index f569ad3..4f2a6fd 100644 Binary files a/apple-touch-icon-76x76.png and b/apple-touch-icon-76x76.png differ diff --git a/apple-touch-icon.png b/apple-touch-icon.png index a4bd5b5..2535dbc 100644 Binary files a/apple-touch-icon.png and b/apple-touch-icon.png differ diff --git a/favicon-16x16.png b/favicon-16x16.png index ff7ace5..d4b4378 100644 Binary files a/favicon-16x16.png and b/favicon-16x16.png differ diff --git a/favicon-32x32.png b/favicon-32x32.png index cdfb4e8..239e798 100644 Binary files a/favicon-32x32.png and b/favicon-32x32.png differ diff --git a/pkgdown.yml b/pkgdown.yml index 72c3304..0ad1ae8 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -2,7 +2,7 @@ pandoc: 2.19.2 pkgdown: 2.0.7 pkgdown_sha: ~ articles: {} -last_built: 2024-02-04T08:49Z +last_built: 2024-02-04T08:50Z urls: reference: http://snitch.tada.science/reference article: http://snitch.tada.science/articles diff --git a/reference/fun.html b/reference/fun.html index de055b4..6c47c7d 100644 --- a/reference/fun.html +++ b/reference/fun.html @@ -60,6 +60,10 @@

Arguments diff --git a/search.json b/search.json index 9ff9e24..da18646 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to snitch","title":"Contributing to snitch","text":"outlines propose change snitch. detailed discussion contributing tidyverse packages, please see development contributing guide code review principles.","code":""},{"path":"http://snitch.tada.science/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to snitch","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":"http://snitch.tada.science/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to snitch","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). See guide create great issue advice.","code":""},{"path":"http://snitch.tada.science/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to snitch","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"tadascience/snitch\", fork = TRUE). Install development dependencies 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. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"http://snitch.tada.science/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to snitch","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":"http://snitch.tada.science/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to snitch","text":"Please note snitch project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"http://snitch.tada.science/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 snitch authors 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":"http://snitch.tada.science/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with snitch","title":"Getting help with snitch","text":"Thanks using snitch! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"http://snitch.tada.science/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with snitch","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":"http://snitch.tada.science/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with snitch","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . 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":"http://snitch.tada.science/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with snitch","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"http://snitch.tada.science/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Romain François. Author, maintainer.","code":""},{"path":"http://snitch.tada.science/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"François R (2024). snitch: Spy functions packages. R package version 2024.2.0, http://tada.science/snitch/, https://github.com/tadascience/snitch.","code":"@Manual{, title = {snitch: Spy on functions and packages}, author = {Romain François}, year = {2024}, note = {R package version 2024.2.0, http://tada.science/snitch/}, url = {https://github.com/tadascience/snitch}, }"},{"path":"http://snitch.tada.science/index.html","id":"snitch-","dir":"","previous_headings":"","what":"Spy on functions and packages","title":"Spy on functions and packages","text":"goal snitch …","code":""},{"path":"http://snitch.tada.science/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Spy on functions and packages","text":"can install development version snitch like :","code":"pak::pak(\"tadascience/snitch\")"},{"path":"http://snitch.tada.science/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Spy on functions and packages","text":"","code":"# snitch on one function snitch::fun(rnorm) #> Tracing function \"rnorm\" in package \"stats\" #> [1] \"rnorm\" # snitch on all functions from a package snitch::pkg(\"dplyr\") #> NULL"},{"path":"http://snitch.tada.science/reference/fun.html","id":null,"dir":"Reference","previous_headings":"","what":"Snitch on functions — fun","title":"Snitch on functions — fun","text":"Snitch functions","code":""},{"path":"http://snitch.tada.science/reference/fun.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Snitch on functions — fun","text":"","code":"fun(what, col = \"pink\", where = topenv(parent.frame()))"},{"path":"http://snitch.tada.science/reference/fun.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Snitch on functions — fun","text":"Function snitch col color","code":""},{"path":"http://snitch.tada.science/reference/fun.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Snitch on functions — fun","text":"","code":"fun(rnorm)"},{"path":"http://snitch.tada.science/reference/pkg.html","id":null,"dir":"Reference","previous_headings":"","what":"Snitch on functions from a package — pkg","title":"Snitch on functions from a package — pkg","text":"Snitch functions package","code":""},{"path":"http://snitch.tada.science/reference/pkg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Snitch on functions from a package — pkg","text":"","code":"pkg(pkg, pattern = \"\", col = \"pink\")"},{"path":"http://snitch.tada.science/reference/pkg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Snitch on functions from a package — pkg","text":"pkg package snitch pattern filter functions col color","code":""},{"path":"http://snitch.tada.science/reference/pkg.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Snitch on functions from a package — pkg","text":"","code":"pkg(\"dplyr\") #> Error in loadNamespace(name): there is no package called ‘dplyr’"}] +[{"path":[]},{"path":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/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":"http://snitch.tada.science/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contributing to snitch","title":"Contributing to snitch","text":"outlines propose change snitch. detailed discussion contributing tidyverse packages, please see development contributing guide code review principles.","code":""},{"path":"http://snitch.tada.science/CONTRIBUTING.html","id":"fixing-typos","dir":"","previous_headings":"","what":"Fixing typos","title":"Contributing to snitch","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":"http://snitch.tada.science/CONTRIBUTING.html","id":"bigger-changes","dir":"","previous_headings":"","what":"Bigger changes","title":"Contributing to snitch","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). See guide create great issue advice.","code":""},{"path":"http://snitch.tada.science/CONTRIBUTING.html","id":"pull-request-process","dir":"","previous_headings":"Bigger changes","what":"Pull request process","title":"Contributing to snitch","text":"Fork package clone onto computer. haven’t done , recommend using usethis::create_from_github(\"tadascience/snitch\", fork = TRUE). Install development dependencies 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. user-facing changes, add bullet top NEWS.md (.e. just first header). Follow style described https://style.tidyverse.org/news.html.","code":""},{"path":"http://snitch.tada.science/CONTRIBUTING.html","id":"code-style","dir":"","previous_headings":"Bigger changes","what":"Code style","title":"Contributing to snitch","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":"http://snitch.tada.science/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contributing to snitch","text":"Please note snitch project released Contributor Code Conduct. contributing project agree abide terms.","code":""},{"path":"http://snitch.tada.science/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2024 snitch authors 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":"http://snitch.tada.science/SUPPORT.html","id":null,"dir":"","previous_headings":"","what":"Getting help with snitch","title":"Getting help with snitch","text":"Thanks using snitch! filing issue, places explore pieces put together make process smooth possible.","code":""},{"path":"http://snitch.tada.science/SUPPORT.html","id":"make-a-reprex","dir":"","previous_headings":"","what":"Make a reprex","title":"Getting help with snitch","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":"http://snitch.tada.science/SUPPORT.html","id":"where-to-ask","dir":"","previous_headings":"","what":"Where to ask?","title":"Getting help with snitch","text":"Armed reprex, next step figure ask. ’s question: start community.rstudio.com, /StackOverflow. people answer questions. ’s bug: ’re right place, file issue. ’re sure: let community help figure ! problem bug feature request, can easily return report . 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":"http://snitch.tada.science/SUPPORT.html","id":"what-happens-next","dir":"","previous_headings":"","what":"What happens next?","title":"Getting help with snitch","text":"efficient possible, development tidyverse packages tends bursty, shouldn’t worry don’t get immediate response. Typically don’t look repo sufficient quantity issues accumulates, ’s burst intense activity focus efforts. makes development efficient avoids expensive context switching problems, cost taking longer get back . process makes good reprex particularly important might multiple months initial report start working . can’t reproduce bug, can’t fix !","code":""},{"path":"http://snitch.tada.science/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Romain François. Author, maintainer.","code":""},{"path":"http://snitch.tada.science/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"François R (2024). snitch: Spy functions packages. R package version 2024.2.0, http://tada.science/snitch/, https://github.com/tadascience/snitch.","code":"@Manual{, title = {snitch: Spy on functions and packages}, author = {Romain François}, year = {2024}, note = {R package version 2024.2.0, http://tada.science/snitch/}, url = {https://github.com/tadascience/snitch}, }"},{"path":"http://snitch.tada.science/index.html","id":"snitch-","dir":"","previous_headings":"","what":"Spy on functions and packages","title":"Spy on functions and packages","text":"goal snitch …","code":""},{"path":"http://snitch.tada.science/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Spy on functions and packages","text":"can install development version snitch like :","code":"pak::pak(\"tadascience/snitch\")"},{"path":"http://snitch.tada.science/index.html","id":"example","dir":"","previous_headings":"","what":"Example","title":"Spy on functions and packages","text":"","code":"# snitch on one function snitch::fun(rnorm) #> Tracing function \"rnorm\" in package \"stats\" #> [1] \"rnorm\" # snitch on all functions from a package snitch::pkg(\"dplyr\") #> NULL"},{"path":"http://snitch.tada.science/reference/fun.html","id":null,"dir":"Reference","previous_headings":"","what":"Snitch on functions — fun","title":"Snitch on functions — fun","text":"Snitch functions","code":""},{"path":"http://snitch.tada.science/reference/fun.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Snitch on functions — fun","text":"","code":"fun(what, col = \"pink\", where = topenv(parent.frame()))"},{"path":"http://snitch.tada.science/reference/fun.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Snitch on functions — fun","text":"Function snitch col color look function snitched ","code":""},{"path":"http://snitch.tada.science/reference/fun.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Snitch on functions — fun","text":"","code":"fun(rnorm)"},{"path":"http://snitch.tada.science/reference/pkg.html","id":null,"dir":"Reference","previous_headings":"","what":"Snitch on functions from a package — pkg","title":"Snitch on functions from a package — pkg","text":"Snitch functions package","code":""},{"path":"http://snitch.tada.science/reference/pkg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Snitch on functions from a package — pkg","text":"","code":"pkg(pkg, pattern = \"\", col = \"pink\")"},{"path":"http://snitch.tada.science/reference/pkg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Snitch on functions from a package — pkg","text":"pkg package snitch pattern filter functions col color","code":""},{"path":"http://snitch.tada.science/reference/pkg.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Snitch on functions from a package — pkg","text":"","code":"pkg(\"dplyr\") #> Error in loadNamespace(name): there is no package called ‘dplyr’"}]