diff --git a/main/404.html b/main/404.html index cb0ea547..022b8a7d 100644 --- a/main/404.html +++ b/main/404.html @@ -29,7 +29,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -50,12 +50,6 @@ Changelog - - Versions main - diff --git a/main/CODE_OF_CONDUCT.html b/main/CODE_OF_CONDUCT.html index e788e230..854d1f3e 100644 --- a/main/CODE_OF_CONDUCT.html +++ b/main/CODE_OF_CONDUCT.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/CONTRIBUTING.html b/main/CONTRIBUTING.html index f7bfd9d6..2b34c5c6 100644 --- a/main/CONTRIBUTING.html +++ b/main/CONTRIBUTING.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/LICENSE-text.html b/main/LICENSE-text.html index 3071b873..d8a473f6 100644 --- a/main/LICENSE-text.html +++ b/main/LICENSE-text.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/PULL_REQUEST_TEMPLATE.html b/main/PULL_REQUEST_TEMPLATE.html index a3db8823..797105a9 100644 --- a/main/PULL_REQUEST_TEMPLATE.html +++ b/main/PULL_REQUEST_TEMPLATE.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/SECURITY.html b/main/SECURITY.html index 5eda3c04..8ee39733 100644 --- a/main/SECURITY.html +++ b/main/SECURITY.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/articles/hello.html b/main/articles/hello.html index 86251fc8..f591773b 100644 --- a/main/articles/hello.html +++ b/main/articles/hello.html @@ -31,7 +31,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -52,12 +52,6 @@ Changelog - - Versions main - diff --git a/main/articles/index.html b/main/articles/index.html index 862d8d2b..3e5f622d 100644 --- a/main/articles/index.html +++ b/main/articles/index.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/authors.html b/main/authors.html index 74fea422..6037c926 100644 --- a/main/authors.html +++ b/main/authors.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - @@ -75,13 +69,13 @@ Citation insightsengineering (2024). r.pkg.template: R Package Template. -R package version 0.1.0.9156, https://github.com/insightsengineering/r.pkg.template/. +R package version 0.1.0.9157, https://github.com/insightsengineering/r.pkg.template/. @Manual{, title = {r.pkg.template: R Package Template}, author = {{insightsengineering}}, year = {2024}, - note = {R package version 0.1.0.9156}, + note = {R package version 0.1.0.9157}, url = {https://github.com/insightsengineering/r.pkg.template/}, } diff --git a/main/index.html b/main/index.html index 7911c433..bcb379ad 100644 --- a/main/index.html +++ b/main/index.html @@ -31,7 +31,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -52,12 +52,6 @@ Changelog - - Versions main - diff --git a/main/news/index.html b/main/news/index.html index 6377e8cc..787cab0e 100644 --- a/main/news/index.html +++ b/main/news/index.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - @@ -62,17 +56,17 @@ -r.pkg.template 0.1.0.9156 +r.pkg.template 0.1.0.9157 -New features +New features Add an initializer script. -Enhancements +Enhancements Documentation on how to use the initialize a package. -Bug fixes +Bug fixes None. diff --git a/main/pkgdown.yml b/main/pkgdown.yml index f55b4d6d..cae002de 100644 --- a/main/pkgdown.yml +++ b/main/pkgdown.yml @@ -3,7 +3,7 @@ pkgdown: 2.0.9 pkgdown_sha: ~ articles: hello: hello.html -last_built: 2024-05-10T11:06Z +last_built: 2024-05-10T11:34Z urls: reference: https://insightsengineering.github.io/r.pkg.template/reference article: https://insightsengineering.github.io/r.pkg.template/articles diff --git a/main/reference/hello.html b/main/reference/hello.html index 044bba6a..085727d0 100644 --- a/main/reference/hello.html +++ b/main/reference/hello.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/reference/index.html b/main/reference/index.html index c453bfa6..a33583c9 100644 --- a/main/reference/index.html +++ b/main/reference/index.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main - diff --git a/main/reference/plumber_api.html b/main/reference/plumber_api.html index f2646678..4bffdc71 100644 --- a/main/reference/plumber_api.html +++ b/main/reference/plumber_api.html @@ -17,7 +17,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -37,12 +37,6 @@ Changelog - - Versions main - diff --git a/main/reference/shiny_app.html b/main/reference/shiny_app.html index e4395c16..18188fdc 100644 --- a/main/reference/shiny_app.html +++ b/main/reference/shiny_app.html @@ -17,7 +17,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -37,12 +37,6 @@ Changelog - - Versions main - diff --git a/main/search.json b/main/search.json index 739137a6..93d3e70b 100644 --- a/main/search.json +++ b/main/search.json @@ -1 +1 @@ -[{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/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 [INSERT CONTACT METHOD]. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/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. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contribution Guidelines","title":"Contribution Guidelines","text":"🙏 Thank taking time contribute! input deeply valued, whether issue, pull request, even feedback, regardless size, content scope.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"table-of-contents","dir":"","previous_headings":"","what":"Table of contents","title":"Contribution Guidelines","text":"👶 Getting started 📔 Code Conduct 🗃 License 📜 Issues 🚩 Pull requests 💻 Coding guidelines 🏆 Recognition model ❓ Questions","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting started","title":"Contribution Guidelines","text":"Please refer project documentation brief introduction. Please also see articles within project documentation additional information.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contribution Guidelines","text":"Code Conduct governs project. Participants contributors expected follow rules outlined therein.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Contribution Guidelines","text":"contributions covered project’s license.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"issues","dir":"","previous_headings":"","what":"Issues","title":"Contribution Guidelines","text":"use GitHub track issues, feature requests, bugs. submitting new issue, please check issue already reported. issue already exists, please upvote existing issue 👍. new feature requests, please elaborate context benefit feature users, developers, relevant personas.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"github-flow","dir":"","previous_headings":"Pull requests","what":"GitHub Flow","title":"Contribution Guidelines","text":"repository uses GitHub Flow model collaboration. submit pull request: Create branch Please see branch naming convention . don’t write access repository, please fork . Make changes Make sure code passes checks imposed GitHub Actions well documented well tested unit tests sufficiently covering changes introduced Create pull request (PR) pull request description, please link relevant issue (), provide detailed description change, include assumptions. Address review comments, Post approval Merge PR write access. Otherwise, reviewer merge PR behalf. Pat back Congratulations! 🎉 now official contributor project! grateful contribution.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"branch-naming-convention","dir":"","previous_headings":"Pull requests","what":"Branch naming convention","title":"Contribution Guidelines","text":"Suppose changes related current issue current project; please name branch follows: _. Please use underscore (_) delimiter word separation. example, 420_fix_ui_bug suitable branch name change resolving UI-related bug reported issue number 420 current project. change affects multiple repositories, please name branches follows: __. example, 69_awesomeproject_fix_spelling_error reference issue 69 reported project awesomeproject aims resolve one spelling errors multiple (likely related) repositories.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"monorepo-and-stageddependencies","dir":"","previous_headings":"Pull requests","what":"monorepo and staged.dependencies","title":"Contribution Guidelines","text":"Sometimes might need change upstream dependent package(s) able submit meaningful change. using staged.dependencies functionality simulate monorepo behavior. dependency configuration already specified project’s staged_dependencies.yaml file. need name feature branches appropriately. exception branch naming convention described . Please refer staged.dependencies package documentation details.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"coding-guidelines","dir":"","previous_headings":"","what":"Coding guidelines","title":"Contribution Guidelines","text":"repository follows unified processes standards adopted maintainers ensure software development carried consistently within teams cohesively across repositories.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"style-guide","dir":"","previous_headings":"Coding guidelines","what":"Style guide","title":"Contribution Guidelines","text":"repository follows standard tidyverse style guide uses lintr lint checks. Customized lint configurations available repository’s .lintr file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"dependency-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency management","title":"Contribution Guidelines","text":"Lightweight right weight. repository follows tinyverse recommedations limiting dependencies minimum.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"dependency-version-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency version management","title":"Contribution Guidelines","text":"code compatible (!) historical versions given dependenct package, required specify minimal version DESCRIPTION file. particular: development version requires (imports) development version another package - required put abc (>= 1.2.3.9000).","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"r--package-versions","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"R & package versions","title":"Contribution Guidelines","text":"continuously test packages newest R version along recent dependencies CRAN BioConductor. recommend working environment also set way. can find details R version packages used R CMD check GitHub Action execution log - step prints R sessionInfo(). discover bugs older R versions older set dependencies, please create relevant bug reports.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"pre-commit","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"pre-commit","title":"Contribution Guidelines","text":"highly recommend use pre-commit tool combined R hooks pre-commit execute checks committing pushing changes. Pre-commit hooks already available repository’s .pre-commit-config.yaml file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"recognition-model","dir":"","previous_headings":"","what":"Recognition model","title":"Contribution Guidelines","text":"mentioned previously, contributions deeply valued appreciated. contribution data available part repository insights, recognize significant contribution hence add contributor package authors list, following rules enforced: Minimum 5% lines code authored* (determined git blame query) top 5 contributors terms number commits lines added lines removed* *Excluding auto-generated code, including limited roxygen comments renv.lock files. package maintainer also reserves right adjust criteria recognize contributions.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/CONTRIBUTING.html","id":"questions","dir":"","previous_headings":"","what":"Questions","title":"Contribution Guidelines","text":"questions regarding contribution guidelines, please contact package/repository maintainer.","code":""},{"path":[]},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/SECURITY.html","id":"reporting-security-issues","dir":"","previous_headings":"","what":"Reporting Security Issues","title":"Security Policy","text":"believe found security vulnerability repositories organization, please report us coordinated disclosure. Please report security vulnerabilities public GitHub issues, discussions, pull requests. Instead, please send email vulnerability.management[@]roche.com. Please include much information listed can help us better understand resolve issue: type issue (e.g., buffer overflow, SQL injection, cross-site scripting) Full paths source file(s) related manifestation issue location affected source code (tag/branch/commit direct URL) special configuration required reproduce issue Step--step instructions reproduce issue Proof--concept exploit code (possible) Impact issue, including attacker might exploit issue information help us triage report quickly.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/SECURITY.html","id":"data-security-standards-dss","dir":"","previous_headings":"","what":"Data Security Standards (DSS)","title":"Security Policy","text":"Please make sure reporting issues form bug, feature, pull request, sensitive information PII, PHI, PCI completely removed text attachments, including pictures videos.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"insightsengineering. Author, maintainer.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"insightsengineering (2024). r.pkg.template: R Package Template. R package version 0.1.0.9156, https://github.com/insightsengineering/r.pkg.template/.","code":"@Manual{, title = {r.pkg.template: R Package Template}, author = {{insightsengineering}}, year = {2024}, note = {R package version 0.1.0.9156}, url = {https://github.com/insightsengineering/r.pkg.template/}, }"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"rpkgtemplate","dir":"","previous_headings":"","what":"R Package Template","title":"R Package Template","text":"R package template built-GitHub Actions-based CI/CD workflows.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"initialization","dir":"","previous_headings":"Usage","what":"Initialization","title":"R Package Template","text":"initialize repository one two ways:","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"clone-this-template","dir":"","previous_headings":"Usage > Initialization","what":"Clone this template","title":"R Package Template","text":"Clone repository: Run initializer script:","code":"git clone https://github.com/insightsengineering/r.pkg.template.git cd r.pkg.template ./init.sh"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"use-githubs-template-importer","dir":"","previous_headings":"Usage > Initialization","what":"Use GitHub’s template importer","title":"R Package Template","text":"Click generate copy template directly within GitHub. Clone repository account/organization. Run initializer script:","code":"./init.sh"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"cicd-configurations","dir":"","previous_headings":"Usage","what":"CI/CD Configurations","title":"R Package Template","text":"CI/CD jobs defined .github/workflows directory form GitHub Action workflows. can modified per requirements, designed implemented follow best practices ensure highest quality standards package. workflows originating repository can repurposed R package GitHub repositories. 👉 information including detailed description screenshots workflows, please refer Workflows documentation.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"pre-commit","dir":"","previous_headings":"Usage","what":"Pre-commit","title":"R Package Template","text":"repository contains example pre-commit configuration. pre-commit tool uses Git hooks identify resolve simple issues submission code review. Git hooks run every commit automatically point solve issues missing semicolons, trailing whitespaces, code formatting spell checks.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"setting-up-pre-commit-for-r-project","dir":"","previous_headings":"Usage","what":"Setting up pre-commit for R project","title":"R Package Template","text":"Install pre-commit framework. Use official installation guide. Install R package precommit Run use_precommit() function generate example pre-commit configuration called .pre-commit-config.yaml: Install git hooks script: moment , scripts .pre-commit-config.yaml run every git commit command. want run manually without committing can use command pre-commit run ---files. information, please refer official pre-commit documentation. NOTE: Frequently run pre-commit autoupdate update hooks .pre-commit-config.yaml configuration file.","code":"R -e 'install.packages(\"precommit\")' [ ! -f \".pre-commit-config.yaml\" ] && R -e 'precommit::use_precommit()' pre-commit install"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/index.html","id":"example-output-from-pre-commit","dir":"","previous_headings":"Usage","what":"Example output from pre-commit","title":"R Package Template","text":"","code":"$ git add . $ git commit -m \"Add pre-commit configuration\" [INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... style-files..............................................................Passed roxygenize...........................................(no files to check)Skipped use-tidy-description.....................................................Passed spell-check..............................................................Failed - hook id: spell-check - exit code: 1 - files were modified by this hook The following spelling errors were found: WORD FOUND IN commiting README.md:77 indentify README.md:49 informatoin README.md:77 All spelling errors found were copied to inst/WORDLIST assuming they were not spelling errors and will be ignored in the future. Please review the above list and for each word that is an actual typo: - fix it in the source code. - remove it again manually from inst/WORDLIST to make sure it's not ignored in the future. Then, try committing again. Error: Spell check failed Execution halted lintr....................................................................Passed readme-rmd-rendered......................................................Passed parsable-R...............................................................Passed no-browser-statement.....................................................Passed deps-in-desc.............................................................Passed prettier.................................................................Failed - hook id: prettier - files were modified by this hook .pre-commit-config.yaml README.md Check for added large files..............................................Passed Fix End of Files.........................................................Passed Trim Trailing Whitespace.................................................Failed - hook id: trailing-whitespace - exit code: 1 - files were modified by this hook Fixing .pre-commit-config.yaml Fixing README.md Check Yaml...............................................................Passed Don't commit to branch...................................................Passed Mixed line ending........................................................Passed Don't commit common R artifacts......................(no files to check)Skipped"},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/hello.html","id":null,"dir":"Reference","previous_headings":"","what":"Personal greeting — hello","title":"Personal greeting — hello","text":"Greet person appropriately capitalize name.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/hello.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Personal greeting — hello","text":"","code":"hello(name = \"your name\")"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/hello.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Personal greeting — hello","text":"name name (character string; e.g. \"john doe\").","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/hello.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Personal greeting — hello","text":"character string, capitalized title case.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/hello.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Personal greeting — hello","text":"","code":"hello(\"james bond\") #> [1] \"Hello, James Bond\""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/plumber_api.html","id":null,"dir":"Reference","previous_headings":"","what":"Personal greeting as a Plumber API — plumber_api","title":"Personal greeting as a Plumber API — plumber_api","text":"Greet person appropriately capitalize name Plumber API.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/plumber_api.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Personal greeting as a Plumber API — plumber_api","text":"","code":"plumber_api(...)"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/plumber_api.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Personal greeting as a Plumber API — plumber_api","text":"... Additional arguments plumber::pr_run()","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/plumber_api.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Personal greeting as a Plumber API — plumber_api","text":"Plumber API showcasing personal greeting feature.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/shiny_app.html","id":null,"dir":"Reference","previous_headings":"","what":"Personal greeting as a Shiny app — shiny_app","title":"Personal greeting as a Shiny app — shiny_app","text":"Greet person appropriately capitalize name Shiny app.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/shiny_app.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Personal greeting as a Shiny app — shiny_app","text":"","code":"shiny_app()"},{"path":"https://insightsengineering.github.io/r.pkg.template/main/reference/shiny_app.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Personal greeting as a Shiny app — shiny_app","text":"Shiny app showcasing personal greeting feature.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"audityaml","dir":"","previous_headings":"","what":"audit.yaml","title":"What these workflows do?","text":"workflow scans dependencies package vulnerabilities using oysteR. Dependencies can retrieved either DESCRIPTION file renv.lock file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"bioccheckyaml","dir":"","previous_headings":"","what":"bioccheck.yaml","title":"What these workflows do?","text":"workflow implements Bioconductor-specific R package checks BiocCheck.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"branch-cleanupyaml","dir":"","previous_headings":"","what":"branch-cleanup.yaml","title":"What these workflows do?","text":"workflow checks (non-default) branches last commit added configurable number days ago. yes, branches deleted.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"build-check-installyaml","dir":"","previous_headings":"","what":"build-check-install.yaml","title":"What these workflows do?","text":"workflow includes following activities: Build R package. Run R CMD check. Publish unit test summary. Catch notes, warnings etc. R CMD check output. Install package.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"gitleaksyaml","dir":"","previous_headings":"","what":"gitleaks.yaml","title":"What these workflows do?","text":"workflow runs gitleaks repo discover secrets might hardcoded. Additionally, runs presidio-cli find personally identifiable information (PII) within git repo.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"grammaryaml","dir":"","previous_headings":"","what":"grammar.yaml","title":"What these workflows do?","text":"workflow uses write-good check changed files names matching pattern English sentences corrected. , adds annotations pull request problematic grammar can reviewed.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"licensesyaml","dir":"","previous_headings":"","what":"licenses.yaml","title":"What these workflows do?","text":"workflow generates license report R package’s dependencies continuous compliance.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"linksyaml","dir":"","previous_headings":"","what":"links.yaml","title":"What these workflows do?","text":"workflow checks whether URLs embedded code documentation valid. workflow uses lychee detect broken links. Occasionally, check detect false positives strings look like URLs. remedy, please add false positive .lycheeignore file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"linteryaml","dir":"","previous_headings":"","what":"linter.yaml","title":"What these workflows do?","text":"workflow lints codebase using super-linter.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"pkgdownyaml","dir":"","previous_headings":"","what":"pkgdown.yaml","title":"What these workflows do?","text":"Documentation R package generated via workflow. workflow uses pkgdown framework generate documentation HTML, HTML pages deployed gh-pages branch. Moreover, additional Versions dropdown generated via GitHub Action, end user can view multiple versions documentation package.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"releaseyaml","dir":"","previous_headings":"","what":"release.yaml","title":"What these workflows do?","text":"workflow creates GitHub release git tag generates changelog based NEWS.md file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"roxygenyaml","dir":"","previous_headings":"","what":"roxygen.yaml","title":"What these workflows do?","text":"workflow uses roxygen generate .Rd files man/ directory. also checks manuals --date roxygen comments code.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"spellingyaml","dir":"","previous_headings":"","what":"spelling.yaml","title":"What these workflows do?","text":"Spellchecks performed workflow, spelling R package used detect spelling mistakes. inst/WORDLIST file, can add words /acronyms want spell check ignore.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"styleyaml","dir":"","previous_headings":"","what":"style.yaml","title":"What these workflows do?","text":"Code style enforced via styler R package. workflow can configured commit files styling problems automatically, remediating problems.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"test-coverageyaml","dir":"","previous_headings":"","what":"test-coverage.yaml","title":"What these workflows do?","text":"workflow examines test coverage given R package covr. Following , coverage report added PR. Additional feature ability compare code coverage branches, PR can declined coverage decrease following merge. second part workflow runs utilizes covtracer : prepare traceability matrix identify untested behavior verify directly tested functions","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"validationyaml","dir":"","previous_headings":"","what":"validation.yaml","title":"What these workflows do?","text":"workflow generates publishes validation report.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"version-bumpyaml","dir":"","previous_headings":"","what":"version-bump.yaml","title":"What these workflows do?","text":"workflow increases R package version NEWS.md DESCRIPTION files commits change repository.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"versionyaml","dir":"","previous_headings":"","what":"version.yaml","title":"What these workflows do?","text":"workflow checks NEWS.md DESCRPTION files R package version.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/workflows.html","id":"adding-unit-test-and-coverage-reports-to-pkgdown-documentation","dir":"","previous_headings":"","what":"Adding unit test and coverage reports to pkgdown documentation","title":"What these workflows do?","text":"order add unit test reports coverage reports documentation generated pkgdown, following steps needed. ’d like custom branding unit test report, add unit-test-report-brand parameter build-check-install.yaml workflow. See examples . Don’t use skip-r-cmd-install parameter unit test report gets generated. build-check-install.yaml test-coverage.yaml depend pkgdown.yaml workflow. ensure race condition pkgdown.yaml workflow overwrites gh-pages branch avoided. can done example : setting needs: [docs] build-check-install.yaml test-coverage.yaml workflows, build-check-install.yaml test-coverage.yaml invoked another workflow pkgdown.yaml, additional dependency can added trigger test-coverage.yaml build-check-install.yaml pkgdown.yaml finished running. See example . _pkgdown.yaml updated following contents ensure links coverage report unit test report appear navbar. Example configuration main branch: Example configuration tags:","code":"navbar: structure: left: [intro, reference, articles, tutorials, news, reports] right: [search, github] components: reports: text: Reports menu: - text: Coverage report href: coverage-report/ - text: Unit test report href: unit-test-report/ github: icon: fa-github href: name: Check 🛠 on: push: branches: - main workflow_run: workflows: [\"Docs 📚\"] types: - completed jobs: r-cmd: name: R CMD Check 🧬 uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main with: unit-test-report-brand: >- https://github.com/insightsengineering/hex-stickers/raw/main/thumbs/tern.png coverage: name: Coverage 📔 uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main name: Release 🎈 on: push: tags: - \"v*\" jobs: build: name: Build package 🎁 needs: [release, docs] uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main with: unit-test-report-brand: >- https://github.com/insightsengineering/hex-stickers/raw/main/thumbs/tern.png coverage: name: Coverage 📔 needs: [release, docs] uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main docs: name: Pkgdown Docs 📚 needs: release uses: insightsengineering/r.pkg.template/.github/workflows/pkgdown.yaml@main"},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/main/news/index.html","id":"new-features-0-1-0-9156","dir":"Changelog","previous_headings":"","what":"New features","title":"r.pkg.template 0.1.0.9156","text":"Add initializer script.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/news/index.html","id":"enhancements-0-1-0-9156","dir":"Changelog","previous_headings":"","what":"Enhancements","title":"r.pkg.template 0.1.0.9156","text":"Documentation use initialize package.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/main/news/index.html","id":"bug-fixes-0-1-0-9156","dir":"Changelog","previous_headings":"","what":"Bug fixes","title":"r.pkg.template 0.1.0.9156","text":"None.","code":""}] +[{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"our-pledge","dir":"","previous_headings":"","what":"Our Pledge","title":"Contributor Covenant Code of Conduct","text":"members, contributors, leaders pledge make participation community harassment-free experience everyone, regardless age, body size, visible invisible disability, ethnicity, sex characteristics, gender identity expression, level experience, education, socio-economic status, nationality, personal appearance, race, caste, color, religion, sexual identity orientation. pledge act interact ways contribute open, welcoming, diverse, inclusive, healthy community.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"our-standards","dir":"","previous_headings":"","what":"Our Standards","title":"Contributor Covenant Code of Conduct","text":"Examples behavior contributes positive environment community include: Demonstrating empathy kindness toward people respectful differing opinions, viewpoints, experiences Giving gracefully accepting constructive feedback Accepting responsibility apologizing affected mistakes, learning experience Focusing best just us individuals, overall community Examples unacceptable behavior include: use sexualized language imagery, sexual attention advances kind Trolling, insulting derogatory comments, personal political attacks Public private harassment Publishing others’ private information, physical email address, without explicit permission conduct reasonably considered inappropriate professional setting","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"enforcement-responsibilities","dir":"","previous_headings":"","what":"Enforcement Responsibilities","title":"Contributor Covenant Code of Conduct","text":"Community leaders responsible clarifying enforcing standards acceptable behavior take appropriate fair corrective action response behavior deem inappropriate, threatening, offensive, harmful. Community leaders right responsibility remove, edit, reject comments, commits, code, wiki edits, issues, contributions aligned Code Conduct, communicate reasons moderation decisions appropriate.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"scope","dir":"","previous_headings":"","what":"Scope","title":"Contributor Covenant Code of Conduct","text":"Code Conduct applies within community spaces, also applies individual officially representing community public spaces. Examples representing community include using official e-mail address, posting via official social media account, acting appointed representative online offline event.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/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 [INSERT CONTACT METHOD]. complaints reviewed investigated promptly fairly. community leaders obligated respect privacy security reporter incident.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"enforcement-guidelines","dir":"","previous_headings":"","what":"Enforcement Guidelines","title":"Contributor Covenant Code of Conduct","text":"Community leaders follow Community Impact Guidelines determining consequences action deem violation Code Conduct:","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"id_1-correction","dir":"","previous_headings":"Enforcement Guidelines","what":"1. Correction","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Use inappropriate language behavior deemed unprofessional unwelcome community. Consequence: private, written warning community leaders, providing clarity around nature violation explanation behavior inappropriate. public apology may requested.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"id_2-warning","dir":"","previous_headings":"Enforcement Guidelines","what":"2. Warning","title":"Contributor Covenant Code of Conduct","text":"Community Impact: violation single incident series actions. Consequence: warning consequences continued behavior. interaction people involved, including unsolicited interaction enforcing Code Conduct, specified period time. includes avoiding interactions community spaces well external channels like social media. Violating terms may lead temporary permanent ban.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"id_3-temporary-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"3. Temporary Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: serious violation community standards, including sustained inappropriate behavior. Consequence: temporary ban sort interaction public communication community specified period time. public private interaction people involved, including unsolicited interaction enforcing Code Conduct, allowed period. Violating terms may lead permanent ban.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CODE_OF_CONDUCT.html","id":"id_4-permanent-ban","dir":"","previous_headings":"Enforcement Guidelines","what":"4. Permanent Ban","title":"Contributor Covenant Code of Conduct","text":"Community Impact: Demonstrating pattern violation community standards, including sustained inappropriate behavior, harassment individual, aggression toward disparagement classes individuals. Consequence: permanent ban sort public interaction within community.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/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. answers common questions code conduct, see FAQ https://www.contributor-covenant.org/faq. Translations available https://www.contributor-covenant.org/translations.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":null,"dir":"","previous_headings":"","what":"Contribution Guidelines","title":"Contribution Guidelines","text":"🙏 Thank taking time contribute! input deeply valued, whether issue, pull request, even feedback, regardless size, content scope.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"table-of-contents","dir":"","previous_headings":"","what":"Table of contents","title":"Contribution Guidelines","text":"👶 Getting started 📔 Code Conduct 🗃 License 📜 Issues 🚩 Pull requests 💻 Coding guidelines 🏆 Recognition model ❓ Questions","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"getting-started","dir":"","previous_headings":"","what":"Getting started","title":"Contribution Guidelines","text":"Please refer project documentation brief introduction. Please also see articles within project documentation additional information.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"code-of-conduct","dir":"","previous_headings":"","what":"Code of Conduct","title":"Contribution Guidelines","text":"Code Conduct governs project. Participants contributors expected follow rules outlined therein.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"license","dir":"","previous_headings":"","what":"License","title":"Contribution Guidelines","text":"contributions covered project’s license.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"issues","dir":"","previous_headings":"","what":"Issues","title":"Contribution Guidelines","text":"use GitHub track issues, feature requests, bugs. submitting new issue, please check issue already reported. issue already exists, please upvote existing issue 👍. new feature requests, please elaborate context benefit feature users, developers, relevant personas.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"github-flow","dir":"","previous_headings":"Pull requests","what":"GitHub Flow","title":"Contribution Guidelines","text":"repository uses GitHub Flow model collaboration. submit pull request: Create branch Please see branch naming convention . don’t write access repository, please fork . Make changes Make sure code passes checks imposed GitHub Actions well documented well tested unit tests sufficiently covering changes introduced Create pull request (PR) pull request description, please link relevant issue (), provide detailed description change, include assumptions. Address review comments, Post approval Merge PR write access. Otherwise, reviewer merge PR behalf. Pat back Congratulations! 🎉 now official contributor project! grateful contribution.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"branch-naming-convention","dir":"","previous_headings":"Pull requests","what":"Branch naming convention","title":"Contribution Guidelines","text":"Suppose changes related current issue current project; please name branch follows: _. Please use underscore (_) delimiter word separation. example, 420_fix_ui_bug suitable branch name change resolving UI-related bug reported issue number 420 current project. change affects multiple repositories, please name branches follows: __. example, 69_awesomeproject_fix_spelling_error reference issue 69 reported project awesomeproject aims resolve one spelling errors multiple (likely related) repositories.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"monorepo-and-stageddependencies","dir":"","previous_headings":"Pull requests","what":"monorepo and staged.dependencies","title":"Contribution Guidelines","text":"Sometimes might need change upstream dependent package(s) able submit meaningful change. using staged.dependencies functionality simulate monorepo behavior. dependency configuration already specified project’s staged_dependencies.yaml file. need name feature branches appropriately. exception branch naming convention described . Please refer staged.dependencies package documentation details.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"coding-guidelines","dir":"","previous_headings":"","what":"Coding guidelines","title":"Contribution Guidelines","text":"repository follows unified processes standards adopted maintainers ensure software development carried consistently within teams cohesively across repositories.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"style-guide","dir":"","previous_headings":"Coding guidelines","what":"Style guide","title":"Contribution Guidelines","text":"repository follows standard tidyverse style guide uses lintr lint checks. Customized lint configurations available repository’s .lintr file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"dependency-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency management","title":"Contribution Guidelines","text":"Lightweight right weight. repository follows tinyverse recommedations limiting dependencies minimum.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"dependency-version-management","dir":"","previous_headings":"Coding guidelines","what":"Dependency version management","title":"Contribution Guidelines","text":"code compatible (!) historical versions given dependenct package, required specify minimal version DESCRIPTION file. particular: development version requires (imports) development version another package - required put abc (>= 1.2.3.9000).","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"r--package-versions","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"R & package versions","title":"Contribution Guidelines","text":"continuously test packages newest R version along recent dependencies CRAN BioConductor. recommend working environment also set way. can find details R version packages used R CMD check GitHub Action execution log - step prints R sessionInfo(). discover bugs older R versions older set dependencies, please create relevant bug reports.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"pre-commit","dir":"","previous_headings":"Coding guidelines > Recommended development environment & tools","what":"pre-commit","title":"Contribution Guidelines","text":"highly recommend use pre-commit tool combined R hooks pre-commit execute checks committing pushing changes. Pre-commit hooks already available repository’s .pre-commit-config.yaml file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"recognition-model","dir":"","previous_headings":"","what":"Recognition model","title":"Contribution Guidelines","text":"mentioned previously, contributions deeply valued appreciated. contribution data available part repository insights, recognize significant contribution hence add contributor package authors list, following rules enforced: Minimum 5% lines code authored* (determined git blame query) top 5 contributors terms number commits lines added lines removed* *Excluding auto-generated code, including limited roxygen comments renv.lock files. package maintainer also reserves right adjust criteria recognize contributions.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/CONTRIBUTING.html","id":"questions","dir":"","previous_headings":"","what":"Questions","title":"Contribution Guidelines","text":"questions regarding contribution guidelines, please contact package/repository maintainer.","code":""},{"path":[]},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/SECURITY.html","id":"reporting-security-issues","dir":"","previous_headings":"","what":"Reporting Security Issues","title":"Security Policy","text":"believe found security vulnerability repositories organization, please report us coordinated disclosure. Please report security vulnerabilities public GitHub issues, discussions, pull requests. Instead, please send email vulnerability.management[@]roche.com. Please include much information listed can help us better understand resolve issue: type issue (e.g., buffer overflow, SQL injection, cross-site scripting) Full paths source file(s) related manifestation issue location affected source code (tag/branch/commit direct URL) special configuration required reproduce issue Step--step instructions reproduce issue Proof--concept exploit code (possible) Impact issue, including attacker might exploit issue information help us triage report quickly.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/SECURITY.html","id":"data-security-standards-dss","dir":"","previous_headings":"","what":"Data Security Standards (DSS)","title":"Security Policy","text":"Please make sure reporting issues form bug, feature, pull request, sensitive information PII, PHI, PCI completely removed text attachments, including pictures videos.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/authors.html","id":null,"dir":"","previous_headings":"","what":"Authors","title":"Authors and Citation","text":"insightsengineering. Author, maintainer.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/authors.html","id":"citation","dir":"","previous_headings":"","what":"Citation","title":"Authors and Citation","text":"insightsengineering (2024). r.pkg.template: R Package Template. R package version 0.1.0.9157, https://github.com/insightsengineering/r.pkg.template/.","code":"@Manual{, title = {r.pkg.template: R Package Template}, author = {{insightsengineering}}, year = {2024}, note = {R package version 0.1.0.9157}, url = {https://github.com/insightsengineering/r.pkg.template/}, }"},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"rpkgtemplate","dir":"","previous_headings":"","what":"R Package Template","title":"R Package Template","text":"R package template built-GitHub Actions-based CI/CD workflows.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"initialization","dir":"","previous_headings":"Usage","what":"Initialization","title":"R Package Template","text":"initialize repository one two ways:","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"clone-this-template","dir":"","previous_headings":"Usage > Initialization","what":"Clone this template","title":"R Package Template","text":"Clone repository: Run initializer script:","code":"git clone https://github.com/insightsengineering/r.pkg.template.git cd r.pkg.template ./init.sh"},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"use-githubs-template-importer","dir":"","previous_headings":"Usage > Initialization","what":"Use GitHub’s template importer","title":"R Package Template","text":"Click generate copy template directly within GitHub. Clone repository account/organization. Run initializer script:","code":"./init.sh"},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"cicd-configurations","dir":"","previous_headings":"Usage","what":"CI/CD Configurations","title":"R Package Template","text":"CI/CD jobs defined .github/workflows directory form GitHub Action workflows. can modified per requirements, designed implemented follow best practices ensure highest quality standards package. workflows originating repository can repurposed R package GitHub repositories. 👉 information including detailed description screenshots workflows, please refer Workflows documentation.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"pre-commit","dir":"","previous_headings":"Usage","what":"Pre-commit","title":"R Package Template","text":"repository contains example pre-commit configuration. pre-commit tool uses Git hooks identify resolve simple issues submission code review. Git hooks run every commit automatically point solve issues missing semicolons, trailing whitespaces, code formatting spell checks.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"setting-up-pre-commit-for-r-project","dir":"","previous_headings":"Usage","what":"Setting up pre-commit for R project","title":"R Package Template","text":"Install pre-commit framework. Use official installation guide. Install R package precommit Run use_precommit() function generate example pre-commit configuration called .pre-commit-config.yaml: Install git hooks script: moment , scripts .pre-commit-config.yaml run every git commit command. want run manually without committing can use command pre-commit run ---files. information, please refer official pre-commit documentation. NOTE: Frequently run pre-commit autoupdate update hooks .pre-commit-config.yaml configuration file.","code":"R -e 'install.packages(\"precommit\")' [ ! -f \".pre-commit-config.yaml\" ] && R -e 'precommit::use_precommit()' pre-commit install"},{"path":"https://insightsengineering.github.io/r.pkg.template/index.html","id":"example-output-from-pre-commit","dir":"","previous_headings":"Usage","what":"Example output from pre-commit","title":"R Package Template","text":"","code":"$ git add . $ git commit -m \"Add pre-commit configuration\" [INFO] Installing environment for https://github.com/pre-commit/pre-commit-hooks. [INFO] Once installed this environment will be reused. [INFO] This may take a few minutes... style-files..............................................................Passed roxygenize...........................................(no files to check)Skipped use-tidy-description.....................................................Passed spell-check..............................................................Failed - hook id: spell-check - exit code: 1 - files were modified by this hook The following spelling errors were found: WORD FOUND IN commiting README.md:77 indentify README.md:49 informatoin README.md:77 All spelling errors found were copied to inst/WORDLIST assuming they were not spelling errors and will be ignored in the future. Please review the above list and for each word that is an actual typo: - fix it in the source code. - remove it again manually from inst/WORDLIST to make sure it's not ignored in the future. Then, try committing again. Error: Spell check failed Execution halted lintr....................................................................Passed readme-rmd-rendered......................................................Passed parsable-R...............................................................Passed no-browser-statement.....................................................Passed deps-in-desc.............................................................Passed prettier.................................................................Failed - hook id: prettier - files were modified by this hook .pre-commit-config.yaml README.md Check for added large files..............................................Passed Fix End of Files.........................................................Passed Trim Trailing Whitespace.................................................Failed - hook id: trailing-whitespace - exit code: 1 - files were modified by this hook Fixing .pre-commit-config.yaml Fixing README.md Check Yaml...............................................................Passed Don't commit to branch...................................................Passed Mixed line ending........................................................Passed Don't commit common R artifacts......................(no files to check)Skipped"},{"path":[]},{"path":[]},{"path":[]},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/hello.html","id":null,"dir":"Reference","previous_headings":"","what":"Personal greeting — hello","title":"Personal greeting — hello","text":"Greet person appropriately capitalize name.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/hello.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Personal greeting — hello","text":"","code":"hello(name = \"your name\")"},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/hello.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Personal greeting — hello","text":"name name (character string; e.g. \"john doe\").","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/hello.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Personal greeting — hello","text":"character string, capitalized title case.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/hello.html","id":"ref-examples","dir":"Reference","previous_headings":"","what":"Examples","title":"Personal greeting — hello","text":"","code":"hello(\"james bond\") #> [1] \"Hello, James Bond\""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/plumber_api.html","id":null,"dir":"Reference","previous_headings":"","what":"Personal greeting as a Plumber API — plumber_api","title":"Personal greeting as a Plumber API — plumber_api","text":"Greet person appropriately capitalize name Plumber API.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/plumber_api.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Personal greeting as a Plumber API — plumber_api","text":"","code":"plumber_api(...)"},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/plumber_api.html","id":"arguments","dir":"Reference","previous_headings":"","what":"Arguments","title":"Personal greeting as a Plumber API — plumber_api","text":"... Additional arguments plumber::pr_run()","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/plumber_api.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Personal greeting as a Plumber API — plumber_api","text":"Plumber API showcasing personal greeting feature.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/shiny_app.html","id":null,"dir":"Reference","previous_headings":"","what":"Personal greeting as a Shiny app — shiny_app","title":"Personal greeting as a Shiny app — shiny_app","text":"Greet person appropriately capitalize name Shiny app.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/shiny_app.html","id":"ref-usage","dir":"Reference","previous_headings":"","what":"Usage","title":"Personal greeting as a Shiny app — shiny_app","text":"","code":"shiny_app()"},{"path":"https://insightsengineering.github.io/r.pkg.template/reference/shiny_app.html","id":"value","dir":"Reference","previous_headings":"","what":"Value","title":"Personal greeting as a Shiny app — shiny_app","text":"Shiny app showcasing personal greeting feature.","code":""},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"audityaml","dir":"","previous_headings":"","what":"audit.yaml","title":"What these workflows do?","text":"workflow scans dependencies package vulnerabilities using oysteR. Dependencies can retrieved either DESCRIPTION file renv.lock file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"bioccheckyaml","dir":"","previous_headings":"","what":"bioccheck.yaml","title":"What these workflows do?","text":"workflow implements Bioconductor-specific R package checks BiocCheck.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"branch-cleanupyaml","dir":"","previous_headings":"","what":"branch-cleanup.yaml","title":"What these workflows do?","text":"workflow checks (non-default) branches last commit added configurable number days ago. yes, branches deleted.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"build-check-installyaml","dir":"","previous_headings":"","what":"build-check-install.yaml","title":"What these workflows do?","text":"workflow includes following activities: Build R package. Run R CMD check. Publish unit test summary. Catch notes, warnings etc. R CMD check output. Install package.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"gitleaksyaml","dir":"","previous_headings":"","what":"gitleaks.yaml","title":"What these workflows do?","text":"workflow runs gitleaks repo discover secrets might hardcoded. Additionally, runs presidio-cli find personally identifiable information (PII) within git repo.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"grammaryaml","dir":"","previous_headings":"","what":"grammar.yaml","title":"What these workflows do?","text":"workflow uses write-good check changed files names matching pattern English sentences corrected. , adds annotations pull request problematic grammar can reviewed.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"licensesyaml","dir":"","previous_headings":"","what":"licenses.yaml","title":"What these workflows do?","text":"workflow generates license report R package’s dependencies continuous compliance.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"linksyaml","dir":"","previous_headings":"","what":"links.yaml","title":"What these workflows do?","text":"workflow checks whether URLs embedded code documentation valid. workflow uses lychee detect broken links. Occasionally, check detect false positives strings look like URLs. remedy, please add false positive .lycheeignore file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"linteryaml","dir":"","previous_headings":"","what":"linter.yaml","title":"What these workflows do?","text":"workflow lints codebase using super-linter.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"pkgdownyaml","dir":"","previous_headings":"","what":"pkgdown.yaml","title":"What these workflows do?","text":"Documentation R package generated via workflow. workflow uses pkgdown framework generate documentation HTML, HTML pages deployed gh-pages branch. Moreover, additional Versions dropdown generated via GitHub Action, end user can view multiple versions documentation package.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"releaseyaml","dir":"","previous_headings":"","what":"release.yaml","title":"What these workflows do?","text":"workflow creates GitHub release git tag generates changelog based NEWS.md file.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"roxygenyaml","dir":"","previous_headings":"","what":"roxygen.yaml","title":"What these workflows do?","text":"workflow uses roxygen generate .Rd files man/ directory. also checks manuals --date roxygen comments code.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"spellingyaml","dir":"","previous_headings":"","what":"spelling.yaml","title":"What these workflows do?","text":"Spellchecks performed workflow, spelling R package used detect spelling mistakes. inst/WORDLIST file, can add words /acronyms want spell check ignore.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"styleyaml","dir":"","previous_headings":"","what":"style.yaml","title":"What these workflows do?","text":"Code style enforced via styler R package. workflow can configured commit files styling problems automatically, remediating problems.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"test-coverageyaml","dir":"","previous_headings":"","what":"test-coverage.yaml","title":"What these workflows do?","text":"workflow examines test coverage given R package covr. Following , coverage report added PR. Additional feature ability compare code coverage branches, PR can declined coverage decrease following merge. second part workflow runs utilizes covtracer : prepare traceability matrix identify untested behavior verify directly tested functions","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"validationyaml","dir":"","previous_headings":"","what":"validation.yaml","title":"What these workflows do?","text":"workflow generates publishes validation report.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"version-bumpyaml","dir":"","previous_headings":"","what":"version-bump.yaml","title":"What these workflows do?","text":"workflow increases R package version NEWS.md DESCRIPTION files commits change repository.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"versionyaml","dir":"","previous_headings":"","what":"version.yaml","title":"What these workflows do?","text":"workflow checks NEWS.md DESCRPTION files R package version.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/workflows.html","id":"adding-unit-test-and-coverage-reports-to-pkgdown-documentation","dir":"","previous_headings":"","what":"Adding unit test and coverage reports to pkgdown documentation","title":"What these workflows do?","text":"order add unit test reports coverage reports documentation generated pkgdown, following steps needed. ’d like custom branding unit test report, add unit-test-report-brand parameter build-check-install.yaml workflow. See examples . Don’t use skip-r-cmd-install parameter unit test report gets generated. build-check-install.yaml test-coverage.yaml depend pkgdown.yaml workflow. ensure race condition pkgdown.yaml workflow overwrites gh-pages branch avoided. can done example : setting needs: [docs] build-check-install.yaml test-coverage.yaml workflows, build-check-install.yaml test-coverage.yaml invoked another workflow pkgdown.yaml, additional dependency can added trigger test-coverage.yaml build-check-install.yaml pkgdown.yaml finished running. See example . _pkgdown.yaml updated following contents ensure links coverage report unit test report appear navbar. Example configuration main branch: Example configuration tags:","code":"navbar: structure: left: [intro, reference, articles, tutorials, news, reports] right: [search, github] components: reports: text: Reports menu: - text: Coverage report href: coverage-report/ - text: Unit test report href: unit-test-report/ github: icon: fa-github href: name: Check 🛠 on: push: branches: - main workflow_run: workflows: [\"Docs 📚\"] types: - completed jobs: r-cmd: name: R CMD Check 🧬 uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main with: unit-test-report-brand: >- https://github.com/insightsengineering/hex-stickers/raw/main/thumbs/tern.png coverage: name: Coverage 📔 uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main name: Release 🎈 on: push: tags: - \"v*\" jobs: build: name: Build package 🎁 needs: [release, docs] uses: insightsengineering/r.pkg.template/.github/workflows/build-check-install.yaml@main with: unit-test-report-brand: >- https://github.com/insightsengineering/hex-stickers/raw/main/thumbs/tern.png coverage: name: Coverage 📔 needs: [release, docs] uses: insightsengineering/r.pkg.template/.github/workflows/test-coverage.yaml@main docs: name: Pkgdown Docs 📚 needs: release uses: insightsengineering/r.pkg.template/.github/workflows/pkgdown.yaml@main"},{"path":[]},{"path":"https://insightsengineering.github.io/r.pkg.template/news/index.html","id":"new-features-0-1-0-9157","dir":"Changelog","previous_headings":"","what":"New features","title":"r.pkg.template 0.1.0.9157","text":"Add initializer script.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/news/index.html","id":"enhancements-0-1-0-9157","dir":"Changelog","previous_headings":"","what":"Enhancements","title":"r.pkg.template 0.1.0.9157","text":"Documentation use initialize package.","code":""},{"path":"https://insightsengineering.github.io/r.pkg.template/news/index.html","id":"bug-fixes-0-1-0-9157","dir":"Changelog","previous_headings":"","what":"Bug fixes","title":"r.pkg.template 0.1.0.9157","text":"None.","code":""}] diff --git a/main/workflows.html b/main/workflows.html index e55ee6f1..f1c2ead3 100644 --- a/main/workflows.html +++ b/main/workflows.html @@ -15,7 +15,7 @@ r.pkg.template - 0.1.0.9156 + 0.1.0.9157 @@ -35,12 +35,6 @@ Changelog - - Versions main -
insightsengineering (2024). r.pkg.template: R Package Template. -R package version 0.1.0.9156, https://github.com/insightsengineering/r.pkg.template/. +R package version 0.1.0.9157, https://github.com/insightsengineering/r.pkg.template/.
@Manual{, title = {r.pkg.template: R Package Template}, author = {{insightsengineering}}, year = {2024}, - note = {R package version 0.1.0.9156}, + note = {R package version 0.1.0.9157}, url = {https://github.com/insightsengineering/r.pkg.template/}, }