⚠️There's a newer version (0.52) of this package.Take me there.

xfun (version 0.43)

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

974,255

Version

0.43

License

MIT + file LICENSE

Issues

Pull Requests

Stars

148

Forks

Repository

https://github.com/yihui/xfun

Maintainer

Yihui Xie

Last Published

March 25th, 2024

Functions in xfun (0.43)

decimal_dot

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

env_option

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

existing_files

Find file paths that exist

exit_call

Call on.exit() in a parent function

install_dir

Install a source package from a directory

install_github

An alias of remotes::install_github()

fenced_block

Create a fenced block in Markdown

file_string

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

file_ext

Manipulate filename extensions

github_releases

Get the tags of Github releases of a repository

grep_sub

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

mark_dirs

Mark some paths as directories

embed_file

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

download_file

Try various methods to download a file

is_abs_path

Test if paths are relative or absolute

is_ascii

Check if a character vector consists of entirely ASCII characters

is_sub_path

Test if a path is a subpath of a dir

is_blank

Test if a character vector consists of blank strings

numbers_to_words

Convert numbers to English words

normalize_path

Normalize paths

process_file

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

msg_cat

Generate a message with cat()

optipng

Run OptiPNG on all PNG files under a directory

proc_kill

Kill a process and (optionally) all its child processes

is_windows

Test for types of operating systems

isFALSE

Test if an object is FALSE

is_R_CMD_check

Some utility functions for checking packages

protect_math

Protect math expressions in pairs of backticks in Markdown

is_web_path

Test if a path is a web path

raw_string

Print a character vector in its raw form

relative_path

Get the relative path of a path relative to a directory

rename_seq

Rename files with a sequential numeric prefix

format_bytes

Format numbers of bytes using a specified unit

from_root

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

dir_create

Create a directory recursively by default

read_bin

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

rev_check

Run R CMD check on the reverse dependencies of a package

read_all

Read all text files and concatenate their content

rstudio_type

Type a character vector into the RStudio source editor

retry

Retry calling a function for a number of times

magic_path

Find a file or directory under a root directory

pkg_attach

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

parse_only

Parse R code and do not keep the source

rest_api

Get data from a REST API

same_path

Test if two paths are the same after they are normalized

session_info

An alternative to sessionInfo() to print session information

split_lines

Split a character vector by line breaks

set_envvar

Set environment variables

in_dir

Evaluate an expression under a specified working directory

shrink_images

Shrink images to a maximum width

split_source

Split source lines into complete expressions

gsub_file

Search and replace strings in files

native_encode

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

upload_imgur

Upload an image to imgur.com

try_error

Try an expression and see if it throws an error

tree

Turn the output of str() into a tree diagram

yaml_body

Partition the YAML metadata and the body in a document

tinify

Use the Tinify API to compress PNG and JPEG images

news2md

Convert package news to the Markdown format

proj_root

Return the (possible) root directory of a project

record

Run R code and record the results

try_silent

Try to evaluate an expression silently

strict_list

Strict lists

url_accessible

Test if a URL is accessible

tojson

A simple JSON serializer

read_utf8

Read / write files encoded in UTF-8

submit_cran

Submit a source package to CRAN

prose_index

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

yaml_load

Read YAML data

valid_syntax

Check if the syntax of the code is valid

url_filename

Extract filenames from a URLs

strip_html

Strip HTML tags

upload_ftp

Upload to an FTP server via curl

system3

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

attr

Obtain an attribute of an object without partial matching

base64_encode

Encode/decode data into/from base64 encoding.

Get base R package names

base64_uri

Generate the Data URI for a file

Rscript

Run the commands Rscript and R CMD

bg_process

Start a background process

broken_packages

Find out broken packages and reinstall them

Rscript_call

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

csv_options

Parse comma-separated chunk options

cache_rds

Cache the value of an R expression to an RDS file

crandalf_check

Submit check jobs to crandalf

del_empty_dir

Delete an empty directory

dir_exists

Test the existence of files and directories

download_cache

Download a file from a URL and cache it on disk

divide_chunk

Divide chunk options from the code chunk body

do_once

Perform a task once in an R session