From 8d0e2c1021b5dbeb22e96fc6691b17913f528213 Mon Sep 17 00:00:00 2001 From: jimbrig Date: Fri, 11 Feb 2022 02:09:15 +0000 Subject: [PATCH] Built site for pkgdev: 0.0.1@a0ffea8 --- CHANGELOG.html | 1 + pkgdown.yml | 2 +- search.json | 2 +- 3 files changed, 3 insertions(+), 2 deletions(-) diff --git a/CHANGELOG.html b/CHANGELOG.html index ba73c47..9f71798 100644 --- a/CHANGELOG.html +++ b/CHANGELOG.html @@ -79,6 +79,7 @@

Miscellaneous Tasks

Testing

diff --git a/pkgdown.yml b/pkgdown.yml index a45d6e8..83b2c2c 100644 --- a/pkgdown.yml +++ b/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.2 pkgdown_sha: ~ articles: pkgdev: pkgdev.html -last_built: 2022-02-11T02:05Z +last_built: 2022-02-11T02:09Z urls: reference: https://jimbrig.github.io/pkgdev/reference article: https://jimbrig.github.io/pkgdev/articles diff --git a/search.json b/search.json index 5fd27b4..9f12142 100644 --- a/search.json +++ b/search.json @@ -1 +1 @@ -[{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":null,"dir":"","previous_headings":"","what":"Changelog","title":"Changelog","text":"notable changes project documented file.","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"documentation","dir":"","previous_headings":"[unreleased]","what":"Documentation","title":"Changelog","text":"Add readme badge vignette","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"features","dir":"","previous_headings":"[unreleased]","what":"Features","title":"Changelog","text":"Add spelling Add pkgdown local function opener Add codemeta.json metadata Add git-cliff","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"miscellaneous-tasks","dir":"","previous_headings":"[unreleased]","what":"Miscellaneous Tasks","title":"Changelog","text":"Autopublish 2022-02-07T22:10:53Z Autopublish 2022-02-07T22:24:17Z Autopublish 2022-02-07T22:25:03Z Autopublish 2022-02-10T23:31:46Z Autopublish 2022-02-11T00:43:11Z Autopublish 2022-02-11T00:46:28Z Autopublish 2022-02-11T00:46:57Z Autopublish 2022-02-11T00:49:21Z Autopublish 2022-02-11T00:58:10Z Autopublish 2022-02-11T01:01:35Z Autopublish 2022-02-11T01:06:45Z Autopublish 2022-02-11T01:09:18Z Autopublish 2022-02-11T01:12:54Z Autopublish 2022-02-11T01:54:54Z","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"testing","dir":"","previous_headings":"[unreleased]","what":"Testing","title":"Changelog","text":"Add tests check_package_name","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"config","dir":"","previous_headings":"[unreleased]","what":"Config","title":"Changelog","text":"Add various configuration files Update devt Various updates Codecov Ignore codemeta.json Add tests build args Updates","code":""},{"path":"https://jimbrig.github.io/pkgdev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 pkgdev 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":"https://jimbrig.github.io/pkgdev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Jimmy Briggs. Author, maintainer.","code":""},{"path":"https://jimbrig.github.io/pkgdev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Briggs J (2022). pkgdev: Suite Helpers R Package Developer. R package version 0.0.1, https://github.com/jimbrig/pkgdev.","code":"@Manual{, title = {pkgdev: Suite of Helpers for the R Package Developer}, author = {Jimmy Briggs}, year = {2022}, note = {R package version 0.0.1}, url = {https://github.com/jimbrig/pkgdev}, }"},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"r-package-developers-toolkit---pkgdev","dir":"","previous_headings":"","what":"Suite of Helpers for the R Package Developer","title":"Suite of Helpers for the R Package Developer","text":"goal pkgdev provide R Package Developer suite tools simplify aid various processes involved creating, developing, testing, maintaining, overall management R Packages.","code":""},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Suite of Helpers for the R Package Developer","text":"can install development version pkgdev pak like : 1","code":"pak::pak(\"jimbrig/pkgdev\")"},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Suite of Helpers for the R Package Developer","text":"pkgdev comes many tools ---box package developer’s R quickly get started:","code":""},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"create-a-new-package","dir":"","previous_headings":"Usage","what":"Create a new package","title":"Suite of Helpers for the R Package Developer","text":"create new R package locally, run pkgdev::create_pkg(): perform following steps: Create new directory called myawesomepkg Initialize RStudio project, myawesomepkg.Rproj, within directory Jimmy Briggs | jimmy.briggs@jimbrig.com | 2022","code":"pkgdev::create_pkg(\"myawesomepkg\", pkgdevt_script = TRUE, github = TRUE)"},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Package Name — check_package_name","title":"Check Package Name — check_package_name","text":"Checks validity text string formal R Package naming requirements specified Writing R Extensions Manual.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Package Name — check_package_name","text":"","code":"check_package_name(txt)"},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check Package Name — check_package_name","text":"txt String - Proposed package name check validity .","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check Package Name — check_package_name","text":"Boolean - TRUE/FALSE","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check Package Name — check_package_name","text":"\"mandatory 'Package' field gives name package. contain (ASCII) letters, numbers dot, least two characters start letter end dot.\" - Writing R Extensions Manual","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check Package Name — check_package_name","text":"","code":"# Bad Packages check_package_name(\"1pkg\") #> [1] FALSE check_package_name(\"my_awesome_package\") #> [1] FALSE check_package_name(\"a\") #> [1] FALSE # Good packages check_package_name(\"myawesomepkg\") #> [1] TRUE check_package_name(\"my.awesome.pkg\") #> [1] TRUE check_package_name(\"map\") #> [1] TRUE"},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":null,"dir":"Reference","previous_headings":"","what":"Feedback Message Utility Functions - msg_ — feedback","title":"Feedback Message Utility Functions - msg_ — feedback","text":"set helper functions providing verbose feedback developer using functions prefixed msg_ (.e. msg_error, msg_warning, msg_success).","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Feedback Message Utility Functions - msg_ — feedback","text":"","code":"msg_field(x) msg_value(x) msg_done(x) msg_bullet(x, bullet = cli::symbol$bullet) msg_err(x) msg_path(x) msg_info(x) msg_code(x) msg_feedback(x)"},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Feedback Message Utility Functions - msg_ — feedback","text":"x string passed various msg_ functions. bullet use message's bullet. Defaults cli::symbol$bullet","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Feedback Message Utility Functions - msg_ — feedback","text":"See use_feedback_helpers() add functions package!","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":null,"dir":"Reference","previous_headings":"","what":"Indent — indent","title":"Indent — indent","text":"Indentation around various msg_ feedback functions.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Indent — indent","text":"","code":"indent(x, first = \" \", indent = first)"},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Indent — indent","text":"x string passed various msg_ functions. first indent - defaults \" \". indent indentation next line - defaults first","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Indent — indent","text":"string","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":null,"dir":"Reference","previous_headings":"","what":"Inform — inform","title":"Inform — inform","text":"wrapper around rlang::inform() providing feedback developers using packages functions.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Inform — inform","text":"","code":"inform(...)"},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Inform — inform","text":"... Passed rlang::inform()","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Inform — inform","text":"feedback console","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Open pkgdown site of the package — open_pkgdown","title":"Open pkgdown site of the package — open_pkgdown","text":"Open pkgdown site package","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Open pkgdown site of the package — open_pkgdown","text":"","code":"open_pkgdown()"},{"path":"https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Open pkgdown site of the package — open_pkgdown","text":"","code":"if (FALSE) { open_pkgdown() }"},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":null,"dir":"Reference","previous_headings":"","what":"Use Feedback Helpers — use_feedback_helpers","title":"Use Feedback Helpers — use_feedback_helpers","text":"function allows package developer automatically add suite feedback msg_ functions utilized package package.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use Feedback Helpers — use_feedback_helpers","text":"","code":"use_feedback_helpers(pkg = \".\", open = TRUE)"},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use Feedback Helpers — use_feedback_helpers","text":"pkg Package - defaults \".\" open boolean - newly created file opened creation?","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Use Feedback Helpers — use_feedback_helpers","text":"invisibly returns nothing - used side-effects.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Use Feedback Helpers — use_feedback_helpers","text":"Note adds new file package R/utils-msg_helpers.R well runs devtools::document() document added functions corresponding dependencies. functions added : msg_field() msg_value() msg_path() msg_done() msg_bullet() msg_code() msg_feedback() msg_err() msg_info() plus, inform() indent().","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/news/index.html","id":"pkgdev-0009000","dir":"Changelog","previous_headings":"","what":"pkgdev 0.0.0.9000","title":"pkgdev 0.0.0.9000","text":"Added NEWS.md file track changes package.","code":""}] +[{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":null,"dir":"","previous_headings":"","what":"Changelog","title":"Changelog","text":"notable changes project documented file.","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"documentation","dir":"","previous_headings":"[unreleased]","what":"Documentation","title":"Changelog","text":"Add readme badge vignette","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"features","dir":"","previous_headings":"[unreleased]","what":"Features","title":"Changelog","text":"Add spelling Add pkgdown local function opener Add codemeta.json metadata Add git-cliff","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"miscellaneous-tasks","dir":"","previous_headings":"[unreleased]","what":"Miscellaneous Tasks","title":"Changelog","text":"Autopublish 2022-02-07T22:10:53Z Autopublish 2022-02-07T22:24:17Z Autopublish 2022-02-07T22:25:03Z Autopublish 2022-02-10T23:31:46Z Autopublish 2022-02-11T00:43:11Z Autopublish 2022-02-11T00:46:28Z Autopublish 2022-02-11T00:46:57Z Autopublish 2022-02-11T00:49:21Z Autopublish 2022-02-11T00:58:10Z Autopublish 2022-02-11T01:01:35Z Autopublish 2022-02-11T01:06:45Z Autopublish 2022-02-11T01:09:18Z Autopublish 2022-02-11T01:12:54Z Autopublish 2022-02-11T01:54:54Z Autopublish 2022-02-11T01:59:28Z","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"testing","dir":"","previous_headings":"[unreleased]","what":"Testing","title":"Changelog","text":"Add tests check_package_name","code":""},{"path":"https://jimbrig.github.io/pkgdev/CHANGELOG.html","id":"config","dir":"","previous_headings":"[unreleased]","what":"Config","title":"Changelog","text":"Add various configuration files Update devt Various updates Codecov Ignore codemeta.json Add tests build args Updates","code":""},{"path":"https://jimbrig.github.io/pkgdev/LICENSE.html","id":null,"dir":"","previous_headings":"","what":"MIT License","title":"MIT License","text":"Copyright (c) 2022 pkgdev 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":"https://jimbrig.github.io/pkgdev/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"Jimmy Briggs. Author, maintainer.","code":""},{"path":"https://jimbrig.github.io/pkgdev/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"Briggs J (2022). pkgdev: Suite Helpers R Package Developer. R package version 0.0.1, https://github.com/jimbrig/pkgdev.","code":"@Manual{, title = {pkgdev: Suite of Helpers for the R Package Developer}, author = {Jimmy Briggs}, year = {2022}, note = {R package version 0.0.1}, url = {https://github.com/jimbrig/pkgdev}, }"},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"r-package-developers-toolkit---pkgdev","dir":"","previous_headings":"","what":"Suite of Helpers for the R Package Developer","title":"Suite of Helpers for the R Package Developer","text":"goal pkgdev provide R Package Developer suite tools simplify aid various processes involved creating, developing, testing, maintaining, overall management R Packages.","code":""},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"installation","dir":"","previous_headings":"","what":"Installation","title":"Suite of Helpers for the R Package Developer","text":"can install development version pkgdev pak like : 1","code":"pak::pak(\"jimbrig/pkgdev\")"},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"usage","dir":"","previous_headings":"","what":"Usage","title":"Suite of Helpers for the R Package Developer","text":"pkgdev comes many tools ---box package developer’s R quickly get started:","code":""},{"path":"https://jimbrig.github.io/pkgdev/index.html","id":"create-a-new-package","dir":"","previous_headings":"Usage","what":"Create a new package","title":"Suite of Helpers for the R Package Developer","text":"create new R package locally, run pkgdev::create_pkg(): perform following steps: Create new directory called myawesomepkg Initialize RStudio project, myawesomepkg.Rproj, within directory Jimmy Briggs | jimmy.briggs@jimbrig.com | 2022","code":"pkgdev::create_pkg(\"myawesomepkg\", pkgdevt_script = TRUE, github = TRUE)"},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":null,"dir":"Reference","previous_headings":"","what":"Check Package Name — check_package_name","title":"Check Package Name — check_package_name","text":"Checks validity text string formal R Package naming requirements specified Writing R Extensions Manual.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Check Package Name — check_package_name","text":"","code":"check_package_name(txt)"},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Check Package Name — check_package_name","text":"txt String - Proposed package name check validity .","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Check Package Name — check_package_name","text":"Boolean - TRUE/FALSE","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Check Package Name — check_package_name","text":"\"mandatory 'Package' field gives name package. contain (ASCII) letters, numbers dot, least two characters start letter end dot.\" - Writing R Extensions Manual","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/check_package_name.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Check Package Name — check_package_name","text":"","code":"# Bad Packages check_package_name(\"1pkg\") #> [1] FALSE check_package_name(\"my_awesome_package\") #> [1] FALSE check_package_name(\"a\") #> [1] FALSE # Good packages check_package_name(\"myawesomepkg\") #> [1] TRUE check_package_name(\"my.awesome.pkg\") #> [1] TRUE check_package_name(\"map\") #> [1] TRUE"},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":null,"dir":"Reference","previous_headings":"","what":"Feedback Message Utility Functions - msg_ — feedback","title":"Feedback Message Utility Functions - msg_ — feedback","text":"set helper functions providing verbose feedback developer using functions prefixed msg_ (.e. msg_error, msg_warning, msg_success).","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Feedback Message Utility Functions - msg_ — feedback","text":"","code":"msg_field(x) msg_value(x) msg_done(x) msg_bullet(x, bullet = cli::symbol$bullet) msg_err(x) msg_path(x) msg_info(x) msg_code(x) msg_feedback(x)"},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Feedback Message Utility Functions - msg_ — feedback","text":"x string passed various msg_ functions. bullet use message's bullet. Defaults cli::symbol$bullet","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/feedback.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Feedback Message Utility Functions - msg_ — feedback","text":"See use_feedback_helpers() add functions package!","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":null,"dir":"Reference","previous_headings":"","what":"Indent — indent","title":"Indent — indent","text":"Indentation around various msg_ feedback functions.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Indent — indent","text":"","code":"indent(x, first = \" \", indent = first)"},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Indent — indent","text":"x string passed various msg_ functions. first indent - defaults \" \". indent indentation next line - defaults first","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/indent.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Indent — indent","text":"string","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":null,"dir":"Reference","previous_headings":"","what":"Inform — inform","title":"Inform — inform","text":"wrapper around rlang::inform() providing feedback developers using packages functions.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Inform — inform","text":"","code":"inform(...)"},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Inform — inform","text":"... Passed rlang::inform()","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/inform.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Inform — inform","text":"feedback console","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html","id":null,"dir":"Reference","previous_headings":"","what":"Open pkgdown site of the package — open_pkgdown","title":"Open pkgdown site of the package — open_pkgdown","text":"Open pkgdown site package","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Open pkgdown site of the package — open_pkgdown","text":"","code":"open_pkgdown()"},{"path":"https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Open pkgdown site of the package — open_pkgdown","text":"","code":"if (FALSE) { open_pkgdown() }"},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":null,"dir":"Reference","previous_headings":"","what":"Use Feedback Helpers — use_feedback_helpers","title":"Use Feedback Helpers — use_feedback_helpers","text":"function allows package developer automatically add suite feedback msg_ functions utilized package package.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use Feedback Helpers — use_feedback_helpers","text":"","code":"use_feedback_helpers(pkg = \".\", open = TRUE)"},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use Feedback Helpers — use_feedback_helpers","text":"pkg Package - defaults \".\" open boolean - newly created file opened creation?","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Use Feedback Helpers — use_feedback_helpers","text":"invisibly returns nothing - used side-effects.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Use Feedback Helpers — use_feedback_helpers","text":"Note adds new file package R/utils-msg_helpers.R well runs devtools::document() document added functions corresponding dependencies. functions added : msg_field() msg_value() msg_path() msg_done() msg_bullet() msg_code() msg_feedback() msg_err() msg_info() plus, inform() indent().","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/news/index.html","id":"pkgdev-0009000","dir":"Changelog","previous_headings":"","what":"pkgdev 0.0.0.9000","title":"pkgdev 0.0.0.9000","text":"Added NEWS.md file track changes package.","code":""}]