Learn R Programming

xfun (version 0.52)

Supporting Functions for Packages Maintained by 'Yihui Xie'

Description

Miscellaneous functions commonly used in other packages maintained by 'Yihui Xie'.

Copy Link

Version

Install

install.packages('xfun')

Monthly Downloads

1,311,479

Version

0.52

License

MIT + file LICENSE

Issues

3

Pull Requests

1

Stars

147

Forks

28

Maintainer

Yihui Xie

Last Published

April 2nd, 2025

Functions in xfun (0.52)

embed_file

Embed a file, multiple files, or directory on an HTML page
del_empty_dir

Delete an empty directory
env_option

Retrieve a global option from both options() and environment variables
file_rename

Rename files and directories
file_string

Read a text file and concatenate the lines by '\n'
install_github

An alias of remotes::install_github()
install_dir

Install a source package from a directory
is_sub_path

Test if a path is a subpath of a dir
from_root

Get the relative path of a path in a project relative to the current working directory
existing_files

Find file paths that exist
is_R_CMD_check

Some utility functions for checking packages
github_releases

Get the tags of GitHub releases of a repository
is_ascii

Check if a character vector consists of entirely ASCII characters
is_blank

Test if a character vector consists of blank strings
exit_call

Call on.exit() in a parent function
magic_path

Find a file or directory under a root directory
find_globals

Find global/local variables in R code
mark_dirs

Mark some paths as directories
format_bytes

Format numbers of bytes using a specified unit
download_file

Try various methods to download a file
download_cache

Download a file from a URL and cache it on disk
fenced_block

Create a fenced block in Markdown
html_tag

Tools for HTML tags
file_ext

Manipulate filename extensions
in_dir

Evaluate an expression under a specified working directory
md5

Calculate the MD5 checksums of R objects
md_table

Generate a simple Markdown pipe table
numbers_to_words

Convert numbers to English words
proc_kill

Kill a process and (optionally) all its child processes
process_file

Read a text file, process the text with a function, and write the text back
relative_path

Get the relative path of a path relative to a directory
rename_seq

Rename files with a sequential numeric prefix
is_abs_path

Test if paths are relative or absolute
mime_type

Get the MIME types of files
read_all

Read all text files and concatenate their content
pkg_attach

Attach or load packages, and automatically install missing packages if requested
msg_cat

Generate a message with cat()
raw_string

Print a character vector in its raw form
pkg_bib

Generate BibTeX bibliography databases for R packages
native_encode

Try to use the system native encoding to represent a character vector
is_web_path

Test if a path is a web path
session_info

An alternative to sessionInfo() to print session information
split_lines

Split a character vector by line breaks
rand_unit

Pseudo-random numbers on [0, 1) based on a linear congruential generator
optipng

Run OptiPNG on all PNG files under a directory
same_path

Test if two paths are the same after they are normalized
protect_math

Protect math expressions in pairs of backticks in Markdown
new_app

Create a local web application
set_envvar

Set environment variables
prose_index

Find the indices of lines in Markdown that are prose (not code blocks)
record

Run R code and record the results
proj_root

Return the (possible) root directory of a project
shrink_images

Shrink images to a maximum width
url_accessible

Test if a URL is accessible
join_words

Join multiple words into a single string
news2md

Convert package news to the Markdown format
lazy_save

Save objects to files and lazy-load them
parse_only

Parse R code and do not keep the source
is_windows

Test for types of operating systems
normalize_path

Normalize paths
try_error

Try an expression and see if it throws an error
try_silent

Try to evaluate an expression silently
split_source

Split source lines into complete expressions
strip_html

Strip HTML tags
submit_cran

Submit a source package to CRAN
url_destination

Get the final destination of a URL
url_filename

Extract filenames from a URLs
str_wrap

Wrap character vectors
tabset

Represent a (recursive) list with (nested) tabsets
valid_syntax

Check if the syntax of the code is valid
upload_imgur

Upload an image to imgur.com
gsub_file

Search and replace strings in files
upload_ftp

Upload to an FTP server via curl
rest_api

Get data from a REST API
strict_list

Strict lists
retry

Retry calling a function for a number of times
system3

Run system2() and mark its character output as UTF-8 if appropriate
grep_sub

Perform replacement with gsub() on elements matched from grep()
read_bin

Read all records of a binary file as a raw vector by default
yaml_body

Partition the YAML metadata and the body in a document
read_utf8

Read / write files encoded in UTF-8
taml_load

A simple YAML reader and writer
tinify

Use the Tinify API to compress PNG and JPEG images
yaml_load

Read YAML data
record_print

Print methods for record()
tojson

A simple JSON serializer
rstudio_type

Type a character vector into the RStudio source editor
rev_check

Run R CMD check on the reverse dependencies of a package
tree

Turn the output of str() into a tree diagram
Rscript

Run the commands Rscript and R CMD
base64_encode

Encode/decode data into/from base64 encoding.
base_pkgs

Get base R package names
alnum_id

Generate ID strings
bg_process

Start a background process
Rscript_call

Call a function in a new R session via Rscript()
attr2

Obtain an attribute of an object without partial matching
base64_uri

Generate the Data URI for a file
broken_packages

Find out broken packages and reinstall them
bump_version

Bump version numbers
decimal_dot

Evaluate an expression after forcing the decimal point to be a dot
dir_create

Create a directory recursively by default
dir_exists

Test the existence of files and directories
do_once

Perform a task once in an R session
divide_chunk

Divide chunk options from the code chunk body
cache_rds

Cache the value of an R expression to an RDS file
cache_exec

Cache the execution of an expression in memory or on disk
crandalf_check

Submit check jobs to crandalf
csv_options

Parse comma-separated chunk options