Package: kwb.pkgbuild 0.2.3

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.2.3.tar.gz
kwb.pkgbuild_0.2.3.zip(r-4.5)kwb.pkgbuild_0.2.3.zip(r-4.4)kwb.pkgbuild_0.2.3.zip(r-4.3)
kwb.pkgbuild_0.2.3.tgz(r-4.4-any)kwb.pkgbuild_0.2.3.tgz(r-4.3-any)
kwb.pkgbuild_0.2.3.tar.gz(r-4.5-noble)kwb.pkgbuild_0.2.3.tar.gz(r-4.4-noble)
kwb.pkgbuild_0.2.3.tgz(r-4.4-emscripten)kwb.pkgbuild_0.2.3.tgz(r-4.3-emscripten)
kwb.pkgbuild.pdf |kwb.pkgbuild.html✨
kwb.pkgbuild/json (API)
NEWS

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

Peer review:

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

On CRAN:

automationbest-practicesproject-fakinpublicationr-package-automation

37 exports 2 stars 0.71 score 70 dependencies 1 dependents 1 scripts

Last updated 2 years agofrom:074a26b9ea. Checks:OK: 1 ERROR: 1 NOTE: 5. Indexed: yes.

TargetResultDate
Doc / VignettesOKSep 15 2024
R-4.5-winNOTESep 15 2024
R-4.5-linuxERRORSep 15 2024
R-4.4-winNOTESep 15 2024
R-4.4-macNOTESep 15 2024
R-4.3-winNOTESep 15 2024
R-4.3-macNOTESep 15 2024

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_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:askpassbase64encbriobslibcachemcallrclicliprcpp11crayoncredentialscurldescdigestdownlitevaluatefansifastmapfontawesomefsgertghgitcredsgluehighrhtmltoolshttrhttr2inijquerylibjsonliteknitrkwb.utilslifecyclemagrittrmemoisemimeopensslpillarpkgconfigpkgdownprocessxpspurrrR6raggrappdirsrematch2rlangrmarkdownrprojrootrstudioapisasssessioninfostringistringrsyssystemfontstextshapingtibbletinytexusethisutf8vctrswhiskerwithrxfunxml2yamlzip

Create KWB-R Package from Scratch

Michael Rustler, Hauke Sonnenberg

Rendered fromtutorial.Rmdusingknitr::rmarkdownon Sep 15 2024.

Last update: 2020-11-24
Started: 2018-06-18

How to Install KWB-R Packages From GitHub

Michael Rustler

Rendered frominstall.Rmdusingknitr::rmarkdownon Sep 15 2024.

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
Helper function: read_descriptionread_description
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 .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
Use index.md (used for pkgdown::build_home())use_index_md
Helper function: describe pkg installation in index.Rmd / README.mduse_installation
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
pkgdown for KWBuse_pkgdown
Use READMEuse_readme_md
Write to .gitignorewrite_to_gitignore
Write to .Rbuildignorewrite_to_rbuildignore