xfun (version 0.50)

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

980,215

Version

0.50

License

MIT + file LICENSE

Issues

Pull Requests

Stars

142

Forks

Repository

https://github.com/yihui/xfun

Maintainer

Yihui Xie

Last Published

January 7th, 2025

Functions in xfun (0.50)

cache_rds

Cache the value of an R expression to an RDS file

divide_chunk

Divide chunk options from the code chunk body

fenced_block

Create a fenced block in Markdown

file_ext

Manipulate filename extensions

csv_options

Parse comma-separated chunk options

file_rename

Rename files and directories

file_string

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

dir_exists

Test the existence of files and directories

dir_create

Create a directory recursively by default

do_once

Perform a task once in an R session

download_cache

Download a file from a URL and cache it on disk

download_file

Try various methods to download a file

install_github

An alias of remotes::install_github()

install_dir

Install a source package from a directory

exit_call

Call on.exit() in a parent function

existing_files

Find file paths that exist

format_bytes

Format numbers of bytes using a specified unit

find_globals

Find global/local variables in R code

del_empty_dir

Delete an empty directory

grep_sub

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

gsub_file

Search and replace strings in files

is_ascii

Check if a character vector consists of entirely ASCII characters

is_blank

Test if a character vector consists of blank strings

md5

Calculate the MD5 checksums of R objects

is_web_path

Test if a path is a web path

is_sub_path

Test if a path is a subpath of a dir

md_table

Generate a simple Markdown pipe table

is_abs_path

Test if paths are relative or absolute

is_R_CMD_check

Some utility functions for checking packages

embed_file

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

native_encode

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

mime_type

Get the MIME types of files

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

proj_root

Return the (possible) root directory of a project

msg_cat

Generate a message with cat()

new_app

Create a local web application

join_words

Join multiple words into a single string

lazy_save

Save objects to files and lazy-load them

html_tag

Tools for HTML tags

env_option

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

in_dir

Evaluate an expression under a specified working directory

proc_kill

Kill a process and (optionally) all its child processes

news2md

Convert package news to the Markdown format

is_windows

Test for types of operating systems

parse_only

Parse R code and do not keep the source

normalize_path

Normalize paths

read_all

Read all text files and concatenate their content

prose_index

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

relative_path

Get the relative path of a path relative to a directory

read_utf8

Read / write files encoded in UTF-8

record_print

Print methods for record()

protect_math

Protect math expressions in pairs of backticks in Markdown

rename_seq

Rename files with a sequential numeric prefix

raw_string

Print a character vector in its raw form

magic_path

Find a file or directory under a root directory

process_file

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

rest_api

Get data from a REST API

split_source

Split source lines into complete expressions

mark_dirs

Mark some paths as directories

numbers_to_words

Convert numbers to English words

tree

Turn the output of str() into a tree diagram

try_error

Try an expression and see if it throws an error

str_wrap

Wrap character vectors

upload_ftp

Upload to an FTP server via curl

try_silent

Try to evaluate an expression silently

shrink_images

Shrink images to a maximum width

record

Run R code and record the results

tabset

Represent a (recursive) list with (nested) tabsets

read_bin

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

split_lines

Split a character vector by line breaks

upload_imgur

Upload an image to imgur.com

rstudio_type

Type a character vector into the RStudio source editor

session_info

An alternative to sessionInfo() to print session information

optipng

Run OptiPNG on all PNG files under a directory

pkg_bib

Generate BibTeX bibliography databases for R packages

pkg_attach

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

retry

Retry calling a function for a number of times

url_accessible

Test if a URL is accessible

same_path

Test if two paths are the same after they are normalized

submit_cran

Submit a source package to CRAN

system3

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

taml_load

A simple YAML reader and writer

set_envvar

Set environment variables

yaml_body

Partition the YAML metadata and the body in a document

yaml_load

Read YAML data

tinify

Use the Tinify API to compress PNG and JPEG images

rev_check

Run R CMD check on the reverse dependencies of a package

A simple JSON serializer

url_filename

Extract filenames from a URLs

valid_syntax

Check if the syntax of the code is valid

base_pkgs

Get base R package names

Rscript

Run the commands Rscript and R CMD

base64_encode

Encode/decode data into/from base64 encoding.

attr

Obtain an attribute of an object without partial matching

base64_uri

Generate the Data URI for a file

Rscript_call

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

bg_process

Start a background process

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

cache_exec

Cache the execution of an expression in memory or on disk

crandalf_check

Submit check jobs to crandalf

broken_packages

Find out broken packages and reinstall them