xfun (version 0.54)

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,206,620

Version

0.54

License

MIT + file LICENSE

Issues

Pull Requests

Stars

153

Forks

Repository

https://github.com/yihui/xfun

Maintainer

Yihui Xie

Last Published

October 30th, 2025

Functions in xfun (0.54)

cache_exec

Cache the execution of an expression in memory or on disk

do_once

Perform a task once in an R session

dir_create

Create a directory recursively by default

crandalf_check

Submit check jobs to crandalf

cache_rds

Cache the value of an R expression to an RDS file

divide_chunk

Divide chunk options from the code chunk body

csv_options

Parse comma-separated chunk options

dir_exists

Test the existence of files and directories

existing_files

Find file paths that exist

file_ext

Manipulate filename extensions

fenced_block

Create a fenced block in Markdown

in_dir

Evaluate an expression under a specified working directory

install_dir

Install a source package from a directory

install_github

An alias of remotes::install_github()

html_tag

Tools for HTML tags

exit_call

Call on.exit() in a parent function

format_bytes

Format numbers of bytes using a specified unit

find_globals

Find global/local variables in R code

download_file

Try various methods to download a file

download_cache

Download a file from a URL and cache it on disk

join_words

Join multiple words into a single string

file_string

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

gsub_file

Search and replace strings in files

file_rename

Rename files and directories

grep_sub

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

lazy_save

Save objects to files and lazy-load them

env_option

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

from_root

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

embed_file

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

github_releases

Get the tags of GitHub releases of a repository

is_R_CMD_check

Some utility functions for checking packages

is_abs_path

Test if paths are relative or absolute

news2md

Convert package news to the Markdown format

magic_path

Find a file or directory under a root directory

mark_dirs

Mark some paths as directories

mime_type

Get the MIME types of files

native_encode

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

new_app

Create a local web application

normalize_path

Normalize paths

optipng

Run OptiPNG on all PNG files under a directory

is_blank

Test if a character vector consists of blank strings

is_ascii

Check if a character vector consists of entirely ASCII characters

numbers_to_words

Convert numbers to English words

is_windows

Test for types of operating systems

parse_only

Parse R code and do not keep the source

proc_kill

Kill a process and (optionally) all its child processes

msg_cat

Generate a message with cat()

pkg_attach

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

process_file

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

retry

Retry calling a function for a number of times

rest_api

Get data from a REST API

relative_path

Get the relative path of a path relative to a directory

rename_seq

Rename files with a sequential numeric prefix

proj_root

Return the (possible) root directory of a project

md5

Calculate the MD5 checksums of R objects

is_web_path

Test if a path is a web path

md_table

Generate a simple Markdown pipe table

prose_index

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

is_sub_path

Test if a path is a subpath of a dir

pkg_bib

Generate BibTeX bibliography databases for R packages

rev_check

Run R CMD check on the reverse dependencies of a package

set_envvar

Set environment variables

shrink_images

Shrink images to a maximum width

rstudio_type

Type a character vector into the RStudio source editor

protect_math

Protect math expressions in pairs of backticks in Markdown

split_lines

Split a character vector by line breaks

system3

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

split_source

Split source lines into complete expressions

read_all

Read all text files and concatenate their content

session_info

An alternative to sessionInfo() to print session information

record

Run R code and record the results

tabset

Represent a (recursive) list with (nested) tabsets

raw_string

Print a character vector in its raw form

url_destination

Get the final destination of a URL

url_filename

Extract filenames from a URLs

try_silent

Try to evaluate an expression silently

same_path

Test if two paths are the same after they are normalized

tojson

A simple JSON serializer

record_print

Print methods for record()

url_accessible

Test if a URL is accessible

strip_html

Strip HTML tags

valid_syntax

Check if the syntax of the code is valid

tree

Turn the output of str() into a tree diagram

try_error

Try an expression and see if it throws an error

yaml_load

Read YAML data

yaml_body

Partition the YAML metadata and the body in a document

submit_cran

Submit a source package to CRAN

upload_ftp

Upload to an FTP server via curl

rand_unit

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

upload_imgur

Upload an image to imgur.com

read_utf8

Read / write files encoded in UTF-8

read_bin

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

strict_list

Strict lists

tinify

Use the Tinify API to compress PNG and JPEG images

str_wrap

Wrap character vectors

taml_load

A simple YAML reader and writer

base_pkgs

Get base R package names

Rscript_call

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

Run the commands Rscript and R CMD

base64_encode

Encode/decode data into/from base64 encoding.

bg_process

Start a background process

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

decimal_dot

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

del_empty_dir

Delete an empty directory