Function reference • kwb.pkgbuild

All functions

copy_files_from_vignettes_dir_to_deploy_dir(): Copy files from Vignettes Dir to Deploy idir

create_empty_branch(): Create Empty Branch From Github

create_empty_branch_ghpages(): Create Empty gh-pages branch

create_pkg_dir(): Create Package Directory

deploy_site_github_with_extra_files(): deploy_site_github_with_extra_files

deploy_to_branch_with_extra_files(): Build and deploy a site locally with extra files

get_pkgname(): Helper Function: Get Package Name

git_check_config(): Git Check Configuration

git_setup_user(): Git Setup User (Name and Email)

read_description(): Helper function: read_description

set_github_user(): Set Github User For GIT

use_autopkgdown(): Use Auto Pkgdown

use_badge_appveyor(): Badge appveyor

use_badge_codecov(): Badge codecov

use_badge_cran(): Badge CRAN

use_badge_ghactions(): Badge Github Actions

use_badge_ghactions_pkgdown(): Badge Github Actions Pkgdown

use_badge_ghactions_rcmdcheck(): Badge Github Actions RCMD Check

use_badge_lifecycle(): Badge lifecycle

use_badge_runiverse(): Badge R-Universe

use_badge_travis(): Badge travis

use_codecov(): Adds codecov.yml

use_description(): Use DESCRIPTION with KWB styling

use_ghactions(): Adds default .github/workflows/

use_gitlab_ci_blogdown(): Adds .gitlab-ci.yml (if repo contains on root in a "gh-pages" branch)

use_gitlab_ci_docs(): Adds .gitlab-ci.yml (if repo contains a "docs" subfolder)

use_gitlab_ci_ghpages(): Adds .gitlab-ci.yml (which should be saved in root dir of "gh-pages" branch)

use_gitlab_ci_pkgdown(): Adds .gitlab-ci.yml

use_index_md(): Use index.md (used for pkgdown::build_home())

use_installation(): Helper function: describe pkg installation in index.Rmd / README.md

use_mit_license(): Create MIT licence with KWB style

use_news_md(): Create KWB-styled "NEWS.md"

use_pkg(): Wrapper function for preparing R package with KWB styling

use_pkgdown(): pkgdown for KWB

use_pkg_skeleton(): Use Package Skeleton

use_readme_md(): Use README

write_to_gitignore(): Write to .gitignore

write_to_rbuildignore(): Write to .Rbuildignore