Package: kwb.pkgbuild 0.3.0

Michael Rustler

kwb.pkgbuild: R package for standardised development at KWB

Helper functions for automating R package development at KWB to a predefined style.

Authors:Michael Rustler [aut, cre], Hauke Sonnenberg [aut], FAKIN [fnd], Kompetenzzentrum Wasser Berlin gGmbH [cph]

kwb.pkgbuild_0.3.0.tar.gz
kwb.pkgbuild_0.3.0.zip(r-4.7)kwb.pkgbuild_0.3.0.zip(r-4.6)kwb.pkgbuild_0.3.0.zip(r-4.5)
kwb.pkgbuild_0.3.0.tgz(r-4.6-any)kwb.pkgbuild_0.3.0.tgz(r-4.5-any)
kwb.pkgbuild_0.3.0.tar.gz(r-4.7-any)kwb.pkgbuild_0.3.0.tar.gz(r-4.6-any)
kwb.pkgbuild_0.3.0.tgz(r-4.6-emscripten)
manual.pdf |manual.html✨
DESCRIPTION |NEWS
card.svg |card.png
kwb.pkgbuild/json (API)

# Install 'kwb.pkgbuild' in R:
install.packages('kwb.pkgbuild', repos = c('https://kwb-r.r-universe.dev', 'https://cloud.r-project.org'))

Bug tracker:https://github.com/kwb-r/kwb.pkgbuild/issues

Pkgdown/docs site:https://kwb-r.github.io

On CRAN:

Conda:

automationbest-practicesproject-fakinpublicationr-package-automation

4.26 score 2 stars 1 packages 1 scripts 38 exports 69 dependencies

Last updated from:80354a49e0. Checks:2 ERROR, 2 OK, 5 NOTE. Indexed: yes.

TargetResultTimeFilesSyslog
linux-devel-x86_64ERROR154
source / vignettesOK203
linux-release-x86_64ERROR153
macos-release-arm64NOTE106
macos-oldrel-arm64NOTE129
windows-develNOTE113
windows-releaseNOTE97
windows-oldrelNOTE91
wasm-releaseOK128

Exports:%>%copy_files_from_vignettes_dir_to_deploy_dircreate_empty_branchcreate_empty_branch_ghpagescreate_pkg_dirdeploy_site_github_with_extra_filesdeploy_to_branch_with_extra_filesget_pkgnamegit_check_configgit_setup_userset_github_useruse_autopkgdownuse_badge_appveyoruse_badge_codecovuse_badge_cranuse_badge_ghactionsuse_badge_ghactions_pkgdownuse_badge_ghactions_rcmdcheckuse_badge_lifecycleuse_badge_runiverseuse_badge_travisuse_codecovuse_descriptionuse_ghactionsuse_ghactions_claudeuse_gitlab_ci_blogdownuse_gitlab_ci_docsuse_gitlab_ci_ghpagesuse_gitlab_ci_pkgdownuse_index_mduse_mit_licenseuse_news_mduse_pkguse_pkg_skeletonuse_pkgdownuse_readme_mdwrite_to_gitignorewrite_to_rbuildignore

Dependencies:askpassbase64encbriobslibcachemcallrclicliprcpp11crayoncredentialscurldescdigestdownlitevaluatefansifastmapfontawesomefsgertgitcredsgluehighrhtmltoolshttrhttr2inijquerylibjsonliteknitrkwb.utilslifecyclemagrittrmemoisemimeopensslotelpillarpkgconfigpkgdownprocessxpspurrrR6raggrappdirsrematch2rlangrmarkdownrprojrootrstudioapisasssessioninfostringisyssystemfontstextshapingtibbletinytexusethisutf8vctrswhiskerwithrxfunxml2yamlzip

Create KWB-R Package from Scratch
1 Install required R packages | 2 Configure and create your package | 2.1 Prepare a package directory | 2.2 Create empty R package | 2.3 Parameterise your R package | Author | Package description | 2.4 Create R package structure in KWB-R style | 2.5 Add your R functions | 3 Check your package | 4 Build your package | 5 Document your package | 5.1 Manually | 5.2 Automatically
Rendered fromtutorial.Rmdusingknitr::rmarkdown

Last update: 2026-05-07
Started: 2018-06-18

GitHub Actions for KWB-R Packages
1 Default workflows | 2 Optional: Claude Code workflows | 2.1 Required repository secret | 2.2 What Claude does | 3 Updating workflows in existing packages | 4 Troubleshooting
Rendered fromgithub-actions.Rmdusingknitr::rmarkdown

Last update: 2026-05-07
Started: 2026-05-07

How to Install KWB-R Packages From GitHub
Introduction | 1 GitHub Personal Access Token (PAT) | 1.1 Create GitHub PAT | 1.2 Store GitHub PAT in a Text File | 1.3 Delete GitHub PAT | 2 Installation | 2.1 Set your GITHUB_PAT | 2.2 Dependency | 2.3 KWB-R packages
Rendered frominstall.Rmdusingknitr::rmarkdown

Last update: 2019-10-21
Started: 2019-02-20

Readme and manuals

Help Manual

Help pageTopics
Copy files from Vignettes Dir to Deploy idircopy_files_from_vignettes_dir_to_deploy_dir
Create Empty Branch From Githubcreate_empty_branch
Create Empty gh-pages branchcreate_empty_branch_ghpages
Create Package Directorycreate_pkg_dir
deploy_site_github_with_extra_filesdeploy_site_github_with_extra_files
Build and deploy a site locally with extra filesdeploy_to_branch_with_extra_files
Helper Function: Get Package Nameget_pkgname
Git Check Configurationgit_check_config
Git Setup User (Name and Email)git_setup_user
Set Github User For GITset_github_user
Use Auto Pkgdownuse_autopkgdown
Badge appveyoruse_badge_appveyor
Badge codecovuse_badge_codecov
Badge CRANuse_badge_cran
Badge Github Actionsuse_badge_ghactions
Badge Github Actions Pkgdownuse_badge_ghactions_pkgdown
Badge Github Actions RCMD Checkuse_badge_ghactions_rcmdcheck
Badge lifecycleuse_badge_lifecycle
Badge R-Universeuse_badge_runiverse
Badge travisuse_badge_travis
Adds codecov.ymluse_codecov
Use DESCRIPTION with KWB stylinguse_description
Adds default .github/workflows/use_ghactions
Adds Claude Code workflows to .github/workflows/use_ghactions_claude
Adds .gitlab-ci.yml (if repo contains on root in a "gh-pages" branch)use_gitlab_ci_blogdown
Adds .gitlab-ci.yml (if repo contains a "docs" subfolder)use_gitlab_ci_docs
Adds .gitlab-ci.yml (which should be saved in root dir of "gh-pages" branch)use_gitlab_ci_ghpages
Adds .gitlab-ci.ymluse_gitlab_ci_pkgdown
Create KWB-styled 'index.md'use_index_md
Create MIT licence with KWB styleuse_mit_license
Create KWB-styled "NEWS.md"use_news_md
Wrapper function for preparing R package with KWB stylinguse_pkg
Use Package Skeletonuse_pkg_skeleton
Set up 'pkgdown' with KWB stylinguse_pkgdown
Create KWB-styled 'README.md'use_readme_md
Write to .gitignorewrite_to_gitignore
Write to .Rbuildignorewrite_to_rbuildignore