From a082f3cd8d4c40f512b6736a7a299445fb63f3c3 Mon Sep 17 00:00:00 2001 From: jimbrig Date: Fri, 11 Feb 2022 03:02:45 +0000 Subject: [PATCH] Built site for pkgdev: 0.0.1@a24e9fd --- CHANGELOG.html | 2 + index.html | 4 +- pkgdown.yml | 2 +- reference/create_pkg.html | 98 +++++++++++++++++++++ reference/index.html | 20 +++++ reference/library_dev_packages.html | 109 +++++++++++++++++++++++ reference/render_template.html | 107 ++++++++++++++++++++++ reference/use_pkgdevt_script.html | 132 ++++++++++++++++++++++++++++ search.json | 2 +- sitemap.xml | 12 +++ 10 files changed, 484 insertions(+), 4 deletions(-) create mode 100644 reference/create_pkg.html create mode 100644 reference/library_dev_packages.html create mode 100644 reference/render_template.html create mode 100644 reference/use_pkgdevt_script.html diff --git a/CHANGELOG.html b/CHANGELOG.html index 9f71798..3fff9ba 100644 --- a/CHANGELOG.html +++ b/CHANGELOG.html @@ -80,6 +80,7 @@

Miscellaneous Tasks

Testing

@@ -94,6 +95,7 @@

Config<
  • Ignore codemeta.json
  • Add tests to build args
  • Updates
    • +
  • Coverage gh action
    • diff --git a/index.html b/index.html index efb9c05..5e4baff 100644 --- a/index.html +++ b/index.html @@ -84,9 +84,9 @@

    Usage

    Create a new package

    -

    To create a new R package locally, run pkgdev::create_pkg():

    +

    To create a new R package locally, run pkgdev::create_pkg():

    -pkgdev::create_pkg("myawesomepkg", pkgdevt_script = TRUE, github = TRUE)
    +pkgdev::create_pkg("myawesomepkg", pkgdevt_script = TRUE, github = TRUE)

    This will perform the following steps:

    1. Create a new directory called myawesomepkg diff --git a/pkgdown.yml b/pkgdown.yml index 83b2c2c..2179182 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:09Z +last_built: 2022-02-11T03:02Z urls: reference: https://jimbrig.github.io/pkgdev/reference article: https://jimbrig.github.io/pkgdev/articles diff --git a/reference/create_pkg.html b/reference/create_pkg.html new file mode 100644 index 0000000..591d79b --- /dev/null +++ b/reference/create_pkg.html @@ -0,0 +1,98 @@ + +Create R Package — create_pkg • pkgdev + Skip to contents + + +
      +
      +
      +

      Create R Package

      + Source: R/create_pkg.R +
      create_pkg.Rd
      +
      + +
      +

      This function is a wrapper around usethis::create_package() with some +added functionality listed in details below.

      +
      + +
      +

      Usage

      + 
      create_pkg(path, pkgdevt_script = TRUE, open = TRUE, ...)
      +
      + +
      +

      Arguments

      +
      path
      +

      Path to create package

      +
      pkgdevt_script
      +

      Boolean - Should a pkgdevt.R script be created?

      +
      open
      +

      Should the new package be opened?

      +
      ...
      +

      Passed onto usethis::create_package()

      +
      +
      +

      Value

      +

      invisibly returns 0; used for side-effects.

      +
      + +
      + + +
      +

      Developed by Jimmy Briggs.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + + + + diff --git a/reference/index.html b/reference/index.html index aa7af64..b9d795b 100644 --- a/reference/index.html +++ b/reference/index.html @@ -64,6 +64,11 @@

      All functionscreate_pkg() + +
      Create R Package
      +
      + msg_field() msg_value() msg_done() msg_bullet() msg_err() msg_path() msg_info() msg_code() msg_feedback()
      Feedback Message Utility Functions - msg_
      @@ -79,14 +84,29 @@

      All functionslibrary_dev_packages() + +
      Library Package Development Packages
      +

      + open_pkgdown()
      Open pkgdown site of the package
      + render_template() +
      +
      Render Template
      +
      + use_feedback_helpers()
      Use Feedback Helpers
      +
      + + use_pkgdevt_script() +
      +
      Use a pkgdevt.R script
      diff --git a/reference/library_dev_packages.html b/reference/library_dev_packages.html new file mode 100644 index 0000000..28c1192 --- /dev/null +++ b/reference/library_dev_packages.html @@ -0,0 +1,109 @@ + +Library Package Development Packages — library_dev_packages • pkgdev + Skip to contents + + +
      +
      +
      +

      Library Package Development Packages

      + Source: R/library_dev_packages.R +
      library_dev_packages.Rd
      +
      + +
      +

      This function simply libraries package development R packages into your +environment. See details for which packages are loaded in.

      +
      + +
      +

      Usage

      + 
      library_dev_packages(...)
      +
      + +
      +

      Arguments

      +
      ...
      +

      For future use.

      +
      +
      +

      Value

      +

      invisible

      +
      +
      +

      Details

      +

      The following packages get library'd:

      • usethis

        • +

      • devtools

        • +

      • pkgload

        • +

      • pkgdown

        • +

      • testthat

        • +

      • pkgdown

        • +

      • testthat

        • +

      • roxygen2

        • +

      • knitr

        • +

      • pak

        • +

      • purrr

        • +

      • desc

        • +

      • chameleon

        • +

      • attachment

        • +
      + +
      + + +
      +

      Developed by Jimmy Briggs.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + + + + diff --git a/reference/render_template.html b/reference/render_template.html new file mode 100644 index 0000000..ba0a46a --- /dev/null +++ b/reference/render_template.html @@ -0,0 +1,107 @@ + +Render Template — render_template • pkgdev + Skip to contents + + +
      +
      +
      +

      Render Template

      + Source: R/render_template.R +
      render_template.Rd
      +
      + +
      +

      This function is a modification of usethis::use_template() that applies user +supplied data fields to a given template file via whisker::whisker.render().

      +
      + +
      +

      Usage

      + 
      render_template(template_path, out_path, data = list(), open = TRUE)
      +
      + +
      +

      Arguments

      +
      template_path
      +

      Path to the template file

      +
      out_path
      +

      Path to desired output location

      +
      data
      +

      list of fields to pass to the template file

      +
      open
      +

      logical - should the file be opened?

      +
      +
      +

      Value

      +

      Invisible

      +
      + +
      +

      Examples

      + 
      if (FALSE) {
+render_template(system.file("templates/pkgdevt-script.R", package = "pkgdev"),
+                ".", data = list(package_name = "testPackage"),
+                open = TRUE)
+}
+
      +
      +
      + + +
      +

      Developed by Jimmy Briggs.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + + + + diff --git a/reference/use_pkgdevt_script.html b/reference/use_pkgdevt_script.html new file mode 100644 index 0000000..3d3b56c --- /dev/null +++ b/reference/use_pkgdevt_script.html @@ -0,0 +1,132 @@ + +Use a pkgdevt.R script — use_pkgdevt_script • pkgdev + Skip to contents + + +
      +
      +
      +

      Use a pkgdevt.R script

      + Source: R/use_pkgdevt_script.R +
      use_pkgdevt_script.Rd
      +
      + +
      +

      This function adds a script to inst/scripts/pkgdevt.R to keep track of the +various steps applied setting up your R package.

      +
      + +
      +

      Usage

      + 
      use_pkgdevt_script(
+  package_name = basename(getwd()),
+  package_author = Sys.getenv("FULLNAME", ""),
+  package_description = "My awesome description.",
+  package_title = "My awesome title",
+  github_private_repo = FALSE,
+  open = TRUE,
+  ...
+)
      +
      + +
      +

      Arguments

      +
      package_name
      +

      Name of your package

      +
      package_author
      +

      Author

      +
      package_description
      +

      Description

      +
      package_title
      +

      Title

      +
      github_private_repo
      +

      Logical

      +
      open
      +

      Should the file be opened?

      +
      ...
      +

      if necessary

      +
      +
      +

      Value

      +

      Invisible

      +
      +
      +

      Details

      +

      For details see this package's pkgdevt.R script by running:

      +

      file.edit(fs::path_package("pkgdev", "scripts/pkgdevt.R")).

      +
      +
      +

      See also

      +

      https://github.com/jimbrig/pkgdev/blob/main/inst/scripts/pkgdevt.R

      +
      + +
      +

      Examples

      + 
      if (FALSE) {
+use_pkgdevt_script("testPackage",
+                   package_description = "My awesome description.",
+                   package_title = "package title",
+                   github_private_repo = FALSE)
+}
+
+
      +
      +
      + + +
      +

      Developed by Jimmy Briggs.

      +
      + +
      +

      Site built with pkgdown 2.0.2.

      +
      + +
      + + + + + + + diff --git a/search.json b/search.json index 9f12142..916250b 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 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":""}] +[{"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 Autopublish 2022-02-11T02:03:42Z","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 Coverage gh action","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/create_pkg.html","id":null,"dir":"Reference","previous_headings":"","what":"Create R Package — create_pkg","title":"Create R Package — create_pkg","text":"function wrapper around usethis::create_package() added functionality listed details .","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/create_pkg.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Create R Package — create_pkg","text":"","code":"create_pkg(path, pkgdevt_script = TRUE, open = TRUE, ...)"},{"path":"https://jimbrig.github.io/pkgdev/reference/create_pkg.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Create R Package — create_pkg","text":"path Path create package pkgdevt_script Boolean - pkgdevt.R script created? open new package opened? ... Passed onto usethis::create_package()","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/create_pkg.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Create R Package — create_pkg","text":"invisibly returns 0; used side-effects.","code":""},{"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/library_dev_packages.html","id":null,"dir":"Reference","previous_headings":"","what":"Library Package Development Packages — library_dev_packages","title":"Library Package Development Packages — library_dev_packages","text":"function simply libraries package development R packages environment. See details packages loaded .","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/library_dev_packages.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Library Package Development Packages — library_dev_packages","text":"","code":"library_dev_packages(...)"},{"path":"https://jimbrig.github.io/pkgdev/reference/library_dev_packages.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Library Package Development Packages — library_dev_packages","text":"... future use.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/library_dev_packages.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Library Package Development Packages — library_dev_packages","text":"invisible","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/library_dev_packages.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Library Package Development Packages — library_dev_packages","text":"following packages get library'd: usethis devtools pkgload pkgdown testthat pkgdown testthat roxygen2 knitr pak purrr desc chameleon attachment","code":""},{"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/render_template.html","id":null,"dir":"Reference","previous_headings":"","what":"Render Template — render_template","title":"Render Template — render_template","text":"function modification usethis::use_template() applies user supplied data fields given template file via whisker::whisker.render().","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/render_template.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Render Template — render_template","text":"","code":"render_template(template_path, out_path, data = list(), open = TRUE)"},{"path":"https://jimbrig.github.io/pkgdev/reference/render_template.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Render Template — render_template","text":"template_path Path template file out_path Path desired output location data list fields pass template file open logical - file opened?","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/render_template.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Render Template — render_template","text":"Invisible","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/render_template.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Render Template — render_template","text":"","code":"if (FALSE) { render_template(system.file(\"templates/pkgdevt-script.R\", package = \"pkgdev\"), \".\", data = list(package_name = \"testPackage\"), open = TRUE) }"},{"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/reference/use_pkgdevt_script.html","id":null,"dir":"Reference","previous_headings":"","what":"Use a pkgdevt.R script — use_pkgdevt_script","title":"Use a pkgdevt.R script — use_pkgdevt_script","text":"function adds script inst/scripts/pkgdevt.R keep track various steps applied setting R package.","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_pkgdevt_script.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Use a pkgdevt.R script — use_pkgdevt_script","text":"","code":"use_pkgdevt_script( package_name = basename(getwd()), package_author = Sys.getenv(\"FULLNAME\", \"\"), package_description = \"My awesome description.\", package_title = \"My awesome title\", github_private_repo = FALSE, open = TRUE, ... )"},{"path":"https://jimbrig.github.io/pkgdev/reference/use_pkgdevt_script.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Use a pkgdevt.R script — use_pkgdevt_script","text":"package_name Name package package_author Author package_description Description package_title Title github_private_repo Logical open file opened? ... necessary","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_pkgdevt_script.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Use a pkgdevt.R script — use_pkgdevt_script","text":"Invisible","code":""},{"path":"https://jimbrig.github.io/pkgdev/reference/use_pkgdevt_script.html","id":"details","dir":"Reference","previous_headings":"","what":"Details","title":"Use a pkgdevt.R script — use_pkgdevt_script","text":"details see package's pkgdevt.R script running: file.edit(fs::path_package(\"pkgdev\", \"scripts/pkgdevt.R\")).","code":""},{"path":[]},{"path":"https://jimbrig.github.io/pkgdev/reference/use_pkgdevt_script.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Use a pkgdevt.R script — use_pkgdevt_script","text":"","code":"if (FALSE) { use_pkgdevt_script(\"testPackage\", package_description = \"My awesome description.\", package_title = \"package title\", github_private_repo = FALSE) }"},{"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":""}] diff --git a/sitemap.xml b/sitemap.xml index 43fa917..116a4f8 100644 --- a/sitemap.xml +++ b/sitemap.xml @@ -30,6 +30,9 @@ https://jimbrig.github.io/pkgdev/reference/check_package_name.html + + https://jimbrig.github.io/pkgdev/reference/create_pkg.html + https://jimbrig.github.io/pkgdev/reference/feedback.html @@ -42,10 +45,19 @@ https://jimbrig.github.io/pkgdev/reference/inform.html + + https://jimbrig.github.io/pkgdev/reference/library_dev_packages.html + https://jimbrig.github.io/pkgdev/reference/open_pkgdown.html + + https://jimbrig.github.io/pkgdev/reference/render_template.html + https://jimbrig.github.io/pkgdev/reference/use_feedback_helpers.html + + https://jimbrig.github.io/pkgdev/reference/use_pkgdevt_script.html +