Learn R Programming

xfun (version 0.51)

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,089,356

Version

0.51

License

MIT + file LICENSE

Issues

3

Pull Requests

2

Stars

143

Forks

29

Maintainer

Yihui Xie

Last Published

February 19th, 2025

Functions in xfun (0.51)

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
dir_exists

Test the existence of files and directories
decimal_dot

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

Create a directory recursively by default
divide_chunk

Divide chunk options from the code chunk body
do_once

Perform a task once in an R session
embed_file

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

Find file paths that exist
exit_call

Call on.exit() in a parent function
env_option

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

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

Rename files and directories
install_dir

Install a source package from a directory
install_github

An alias of remotes::install_github()
in_dir

Evaluate an expression under a specified working directory
html_tag

Tools for HTML tags
find_globals

Find global/local variables in R code
magic_path

Find a file or directory under a root directory
format_bytes

Format numbers of bytes using a specified unit
mark_dirs

Mark some paths as directories
lazy_save

Save objects to files and lazy-load them
join_words

Join multiple words into a single string
is_sub_path

Test if a path is a subpath of a dir
download_file

Try various methods to download a file
from_root

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

Get the tags of GitHub releases of a repository
download_cache

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

Calculate the MD5 checksums of R objects
numbers_to_words

Convert numbers to English words
is_ascii

Check if a character vector consists of entirely ASCII characters
is_blank

Test if a character vector consists of blank strings
news2md

Convert package news to the Markdown format
normalize_path

Normalize paths
md_table

Generate a simple Markdown pipe table
grep_sub

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

Create a fenced block in Markdown
file_ext

Manipulate filename extensions
is_web_path

Test if a path is a web path
optipng

Run OptiPNG on all PNG files under a directory
is_abs_path

Test if paths are relative or absolute
gsub_file

Search and replace strings in files
is_R_CMD_check

Some utility functions for checking packages
is_windows

Test for types of operating systems
proc_kill

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

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

Generate a message with cat()
mime_type

Get the MIME types of files
native_encode

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

Generate BibTeX bibliography databases for R packages
process_file

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

Create a local web application
protect_math

Protect math expressions in pairs of backticks in Markdown
raw_string

Print a character vector in its raw form
prose_index

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

Return the (possible) root directory of a project
parse_only

Parse R code and do not keep the source
record_print

Print methods for record()
rename_seq

Rename files with a sequential numeric prefix
retry

Retry calling a function for a number of times
read_all

Read all text files and concatenate their content
rev_check

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

Run R code and record the results
read_utf8

Read / write files encoded in UTF-8
set_envvar

Set environment variables
strict_list

Strict lists
session_info

An alternative to sessionInfo() to print session information
relative_path

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

Strip HTML tags
split_source

Split source lines into complete expressions
read_bin

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

Wrap character vectors
rest_api

Get data from a REST API
shrink_images

Shrink images to a maximum width
split_lines

Split a character vector by line breaks
same_path

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

Type a character vector into the RStudio source editor
try_silent

Try to evaluate an expression silently
submit_cran

Submit a source package to CRAN
tree

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

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

Use the Tinify API to compress PNG and JPEG images
tabset

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

Try an expression and see if it throws an error
taml_load

A simple YAML reader and writer
tojson

A simple JSON serializer
url_filename

Extract filenames from a URLs
upload_ftp

Upload to an FTP server via curl
yaml_load

Read YAML data
yaml_body

Partition the YAML metadata and the body in a document
valid_syntax

Check if the syntax of the code is valid
url_accessible

Test if a URL is accessible
upload_imgur

Upload an image to imgur.com
bump_version

Bump version numbers
Rscript

Run the commands Rscript and R CMD
base64_encode

Encode/decode data into/from base64 encoding.
bg_process

Start a background process
alnum_id

Generate ID strings
broken_packages

Find out broken packages and reinstall them
Rscript_call

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

Generate the Data URI for a file
base_pkgs

Get base R package names
attr

Obtain an attribute of an object without partial matching
del_empty_dir

Delete an empty directory
cache_rds

Cache the value of an R expression to an RDS file