Package index • rpkgkit

Functions

The following functions help you to create and maintain an R package.

add_changelog_in_standalone(): Add or update a changelog entry in a standalone R file
add_double_colons(): Make function calls explicit
add_global_gitgnore(): Add .gitignore to package
add_global_rbuildignore(): Add global .Rbuildignore patterns
air_format() deprecated: Format R code using air
check_air_installed(): Check that the air formatter is installed
badge_translated_by_ai(): Generate AI Translation Disclaimer Badge
browse_standalone(): Browse Standalone R Files Across GitHub
check_pkgdown_reference(): Check that all exported functions are listed in pkgdown reference
convert_func_syntax(): Switch Between Explicit function() and Implicit \() Syntax
create_standalone(): Creates a new standalone R script with YAML metadata header. If path is an R package, the file is created in the R/ subdirectory.
is_dev_context() imported_functions() current_packages(): Get packages from the current context
package_lost_glue_brace() detect_lost_glue_brace(): Detect Lost Glue Brace in glue and cli Expressions
package_print_and_cat() detect_print_and_cat(): Detect print() and cat() Calls (CRAN-Unsafe)
package_unmatched_nocov_marker() detect_unmatched_nocov_marker(): Detect Unmatched nocov Markers
package_fn_arg_path() detect_fn_arg_path(): Detect Default Paths in Exported Function Arguments
flir_fix(): Fix R code or package using flir
inquire_standalone(): Inquire Standalone Files from a GitHub Repository
package_func_arg_explicit() make_func_arg_explicit(): Make Function Arguments Explicit
package_func_call_explicit() make_func_call_explicit(): Make Function Calls Explicit
news_md_check() news_md_show() news_md_add_entry() deprecated: Manage NEWS.md file for R packages
rename_func(): Rename Function Definitions in an R File
render_rmd(): Render an R Markdown or R document to Markdown format
update_time_in_standalone(): Update the last-updated field in standalone R files
use_air_table(): Format Long Vectors and Lists as Aligned Tables with Air
use_bugreports(): Add a BugReports field to a package's DESCRIPTION
use_clangd(): Create a .clangd configuration file
use_hexsticker() deprecated: Use Hex Sticker in README
use_jarl(): Create a jarl.toml configuration file
use_multilanguage_readme(): Create Multilingual README Files
use_r_v4.1.0(): Add a minimum R version dependency to a package
use_url(): Add a URL field to a package's DESCRIPTION
use_vendor(): Use a Vendor Package
use_workflow_rust_compatible_check(): Create a Rust-compatible R-CMD-check Workflow
use_workflow_test_branch(): Create a GitHub Actions Workflow to Sync Main to Test Branch
use_workflow_version_update(): Create a GitHub Actions workflow to auto-update R package version
use_zzz(): Create a (pkgname)-package.R file from a template
use_tidy_addin(): Create an RStudio Addin registration entry for a package function
convert_nonascii_code(): Convert Non-ASCII Code
open_cffinit(): Open the CFF initializer
convert_knitr_chunk_header(): Convert Knitr Chunk Headers in R Markdown Files
package_convert_int_literals() convert_int_literals(): Add Explicit Integer Suffix L to Integer Literals
package_convert_pipe() convert_pipe(): Switch Between the Tidyverse Pipe %>% and the Base Pipe |>
badge_to_readme(): Insert a badge into README badges block
optimize_rmd_yaml(): Enrich the YAML header of ONE Rmd file using the package DESCRIPTION
package_optimize_rmd_yaml(): Enrich the YAML headers of README.Rmd and vignettes/*.Rmd of a package
get_positron_version(): Get the version of the Positron IDE
check_standalone(): Check the format of a custom standalone file
check_sysdeps(): Check whether system development dependencies are installed