Man pages for salim-b/pal
Friendly Convenience/Utility Functions

arrange_bySort vector by another vector
as_chrConvert to a character vector
as_comment_strAssemble an (R) comment string of the desired line width
as_flat_listConvert to a flat list
as_line_feed_chrConvert control character sequence name to actual character...
as_md_listConvert a character vector to a Markdown list
as_md_val_listList values as a Markdown list
as_md_valsFormat values as verbatim Markdown
assert_class_anyAssert object is member of any class
assert_cliAssert CLI tool is available
assert_colsAssert data frame columns
assert_df_or_tibbleAssert object is data frame or tibble (extension)
assert_inf_countAssert count or 'Inf'
as_strConvert to a character scalar (aka string)
augment_pkg_configAugment package configuration metadata
build_readmeBuild 'README.Rmd'
capitalize_firstCapitalize first letter
capture_printCapture printed console output as string
cat_linesConvert to character vector and print newline-separated
check_dots_namedCheck that all named dots arguments are valid
cli_process_exprEvaluate an expression with cli process indication
cli_progress_step_quickQuick cli simplified progress message
cli_qty_lglcli pluralization helpers for booleans
cols_regexCreate readr column specification using regular expression...
desc_dep_vrsnGet dependency version from 'DESCRIPTION' file
desc_listGet all 'DESCRIPTION' file fields as cleaned up list
desc_url_gitGet the Git repository URL from 'DESCRIPTION' file
desc_valueGet value from 'DESCRIPTION' file field, cleaned up and with...
draw_path_treeDraw path tree
dsv_colnamesGet column names of a delimiter-separated string
enum_fn_param_defaultsEnumerate function's default parameter values
enum_strEnumerate vector's elements as string
escape_lfEscape line feeds / newlines
exists_in_namespaceTest if object exists in namespace
flatten_path_treeFlatten path tree
fn_param_defaultsGet function's default parameter values
fuse_regexFuse regular expressions
git_file_mod_timeGet Git file modification time
gitlab_documentConvert to GitLab Flavored Markdown
git_remote_tree_urlGet Git remote tree URL
has_pkg_config_valTest if package configuration value is set
is_equal_dfTest if two data frames/tibbles are equal
is_http_successTest if an HTTP request is successful
is_pkg_cranTest if a package is available on CRAN
is_pkg_dirTest if a directory is an R package
is_pkgdown_dirTest if pkgdown is set up for an R package directory
is_pkg_installedTest if packages are installed
is_urlTest if URL
knitr_table_formatDetermine current knitr table format
ls_pkgList a subset of all installed packages
md_to_xmlParse (R) Markdown as CommonMark XML tree
md_verbConvert to verbatim Markdown
md_xml_subnode_ixDetermine CommonMark XML subnode indices
mime_to_extMIME type to file extension
pal-packagepal: Friendly Convenience/Utility Functions
path_mod_timeGet path modification time
path_scriptDetermine file path of executing script
pipe_tableConvert dataframe/tibble to Markdown pipe table
pkg_config_valGet package configuration value
pkg_config_val_defaultGet default package configuration value
prettify_nrPrettify a numeric vector
print_pkg_configPrint package configuration metadata
reason_pkg_requiredAssemble reason why package is required
reduce_df_listReduce a nested list of data frames / tibbles to a single...
rename_fromRename elements from dictionary
req_cachedPerform a cached HTTP GET request
round_toRound to any number
roxy_blocksGet roxygen2 blocks
roxy_objGet roxygen2 block object
roxy_tag_valueGet an object's roxygen2 tag value(s)
roxy_to_md_linksConvert roxygen2 documentation links to Markdown
safe_maxMaximum (safe)
safe_minMinimum (safe)
safe_seq_lenGenerate an integer sequence of specific length (safe)
sentenceifyConvert to sentence case with trailing punctuation mark
stat_modeStatistical mode
strip_mdStrip Markdown formatting from character vector
strip_md_footnotesStrip Markdown footnotes from character vector
strip_yaml_headerStrip YAML header from R Markdown
test_cliCheck if CLI tool is available
toml_readRead in and parse TOML file as strict list
toml_validateValidate TOML
use_pkgDepend on another package
whenGeneralized 'if'-else for pipes
wrap_chrWrap character in character
write_widgetWrite HTML widget to file
write_widget_depsWrite HTML widget dependencies
xml_to_mdConvert from CommonMark XML to (R) Markdown
salim-b/pal documentation built on Feb. 28, 2025, 6:51 p.m.