skimr

<!DOCTYPE html> <html> <head><title>R: Supporting Functions for Packages Maintained by 'Yihui Xie'</title> <meta http-equiv="Content-Type" content="text/html; charset=utf-8" /> <meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes" /> <link rel="stylesheet" type="text/css" href="R.css" /> </head><body><div class="container"> <h1> Supporting Functions for Packages Maintained by 'Yihui Xie' <img class="toplogo" src="../../../doc/html/Rlogo.svg" alt="[R logo]" /> </h1> <hr/> <div style="text-align: center;"> <a href="../../../doc/html/packages.html"><img class="arrow" src="../../../doc/html/left.jpg" alt="[Up]" /></a> <a href="../../../doc/html/index.html"><img class="arrow" src="../../../doc/html/up.jpg" alt="[Top]" /></a> </div><h2>Documentation for package ‘xfun’ version 0.41</h2> <ul><li><a href="../DESCRIPTION">DESCRIPTION file</a>.</li> <li><a href="../doc/index.html">User guides, package vignettes and other documentation.</a></li> <li><a href="../NEWS">Package NEWS</a>.</li> </ul> <h2>Help Pages</h2> <p style="text-align: center;"> <a href="#A">A</a> <a href="#B">B</a> <a href="#C">C</a> <a href="#D">D</a> <a href="#E">E</a> <a href="#F">F</a> <a href="#G">G</a> <a href="#I">I</a> <a href="#J">J</a> <a href="#L">L</a> <a href="#M">M</a> <a href="#N">N</a> <a href="#O">O</a> <a href="#P">P</a> <a href="#R">R</a> <a href="#S">S</a> <a href="#T">T</a> <a href="#U">U</a> <a href="#V">V</a> <a href="#W">W</a> <a href="#Y">Y</a> <a href="#misc">misc</a> </p> <h2><a id="A">-- A --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="alnum_id.html">alnum_id</a></td> <td>Generate ID strings</td></tr> <tr><td style="width: 25%;"><a href="read_utf8.html">append_unique</a></td> <td>Read / write files encoded in UTF-8</td></tr> <tr><td style="width: 25%;"><a href="read_utf8.html">append_utf8</a></td> <td>Read / write files encoded in UTF-8</td></tr> <tr><td style="width: 25%;"><a href="strict_list.html">as_strict_list</a></td> <td>Strict lists</td></tr> <tr><td style="width: 25%;"><a href="attr.html">attr</a></td> <td>Obtain an attribute of an object without partial matching</td></tr> </table> <h2><a id="B">-- B --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="base64_encode.html">base64_decode</a></td> <td>Encode/decode data into/from base64 encoding.</td></tr> <tr><td style="width: 25%;"><a href="base64_encode.html">base64_encode</a></td> <td>Encode/decode data into/from base64 encoding.</td></tr> <tr><td style="width: 25%;"><a href="base64_uri.html">base64_uri</a></td> <td>Generate the Data URI for a file</td></tr> <tr><td style="width: 25%;"><a href="base_pkgs.html">base_pkgs</a></td> <td>Get base R package names</td></tr> <tr><td style="width: 25%;"><a href="bg_process.html">bg_process</a></td> <td>Start a background process</td></tr> <tr><td style="width: 25%;"><a href="broken_packages.html">broken_packages</a></td> <td>Find out broken packages and reinstall them</td></tr> <tr><td style="width: 25%;"><a href="bump_version.html">bump_version</a></td> <td>Bump version numbers</td></tr> </table> <h2><a id="C">-- C --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="cache_rds.html">cache_rds</a></td> <td>Cache the value of an R expression to an RDS file</td></tr> <tr><td style="width: 25%;"><a href="rev_check.html">compare_Rcheck</a></td> <td>Run 'R CMD check' on the reverse dependencies of a package</td></tr> <tr><td style="width: 25%;"><a href="crandalf_check.html">crandalf_check</a></td> <td>Submit check jobs to crandalf</td></tr> <tr><td style="width: 25%;"><a href="crandalf_check.html">crandalf_results</a></td> <td>Submit check jobs to crandalf</td></tr> </table> <h2><a id="D">-- D --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="del_empty_dir.html">del_empty_dir</a></td> <td>Delete an empty directory</td></tr> <tr><td style="width: 25%;"><a href="dir_create.html">dir_create</a></td> <td>Create a directory recursively by default</td></tr> <tr><td style="width: 25%;"><a href="dir_exists.html">dir_exists</a></td> <td>Test the existence of files and directories</td></tr> <tr><td style="width: 25%;"><a href="download_cache.html">download_cache</a></td> <td>Download a file from a URL and cache it on disk</td></tr> <tr><td style="width: 25%;"><a href="download_file.html">download_file</a></td> <td>Try various methods to download a file</td></tr> <tr><td style="width: 25%;"><a href="do_once.html">do_once</a></td> <td>Perform a task once in an R session</td></tr> </table> <h2><a id="E">-- E --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="embed_file.html">embed_dir</a></td> <td>Embed a file, multiple files, or directory on an HTML page</td></tr> <tr><td style="width: 25%;"><a href="embed_file.html">embed_file</a></td> <td>Embed a file, multiple files, or directory on an HTML page</td></tr> <tr><td style="width: 25%;"><a href="embed_file.html">embed_files</a></td> <td>Embed a file, multiple files, or directory on an HTML page</td></tr> <tr><td style="width: 25%;"><a href="env_option.html">env_option</a></td> <td>Retrieve a global option from both 'options()' and environment variables</td></tr> <tr><td style="width: 25%;"><a href="existing_files.html">existing_files</a></td> <td>Find file paths that exist</td></tr> <tr><td style="width: 25%;"><a href="exit_call.html">exit_call</a></td> <td>Call 'on.exit()' in a parent function</td></tr> </table> <h2><a id="F">-- F --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="dir_exists.html">file_exists</a></td> <td>Test the existence of files and directories</td></tr> <tr><td style="width: 25%;"><a href="file_ext.html">file_ext</a></td> <td>Manipulate filename extensions</td></tr> <tr><td style="width: 25%;"><a href="file_string.html">file_string</a></td> <td>Read a text file and concatenate the lines by "\n"</td></tr> <tr><td style="width: 25%;"><a href="format_bytes.html">format_bytes</a></td> <td>Format numbers of bytes using a specified unit</td></tr> <tr><td style="width: 25%;"><a href="from_root.html">from_root</a></td> <td>Get the relative path of a path in a project relative to the current working directory</td></tr> </table> <h2><a id="G">-- G --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="rest_api.html">github_api</a></td> <td>Get data from a REST API</td></tr> <tr><td style="width: 25%;"><a href="github_releases.html">github_releases</a></td> <td>Get the tags of Github releases of a repository</td></tr> <tr><td style="width: 25%;"><a href="grep_sub.html">grep_sub</a></td> <td>Perform replacement with 'gsub()' on elements matched from 'grep()'</td></tr> <tr><td style="width: 25%;"><a href="gsub_file.html">gsub_dir</a></td> <td>Search and replace strings in files</td></tr> <tr><td style="width: 25%;"><a href="gsub_file.html">gsub_ext</a></td> <td>Search and replace strings in files</td></tr> <tr><td style="width: 25%;"><a href="gsub_file.html">gsub_file</a></td> <td>Search and replace strings in files</td></tr> <tr><td style="width: 25%;"><a href="gsub_file.html">gsub_files</a></td> <td>Search and replace strings in files</td></tr> </table> <h2><a id="I">-- I --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="install_dir.html">install_dir</a></td> <td>Install a source package from a directory</td></tr> <tr><td style="width: 25%;"><a href="install_github.html">install_github</a></td> <td>An alias of 'remotes::install_github()'</td></tr> <tr><td style="width: 25%;"><a href="in_dir.html">in_dir</a></td> <td>Evaluate an expression under a specified working directory</td></tr> <tr><td style="width: 25%;"><a href="is_abs_path.html">is_abs_path</a></td> <td>Test if paths are relative or absolute</td></tr> <tr><td style="width: 25%;"><a href="os.html">is_arm64</a></td> <td>Test for types of operating systems</td></tr> <tr><td style="width: 25%;"><a href="is_ascii.html">is_ascii</a></td> <td>Check if a character vector consists of entirely ASCII characters</td></tr> <tr><td style="width: 25%;"><a href="is_blank.html">is_blank</a></td> <td>Test if a character vector consists of blank strings</td></tr> <tr><td style="width: 25%;"><a href="os.html">is_linux</a></td> <td>Test for types of operating systems</td></tr> <tr><td style="width: 25%;"><a href="os.html">is_macos</a></td> <td>Test for types of operating systems</td></tr> <tr><td style="width: 25%;"><a href="is_abs_path.html">is_rel_path</a></td> <td>Test if paths are relative or absolute</td></tr> <tr><td style="width: 25%;"><a href="is_sub_path.html">is_sub_path</a></td> <td>Test if a path is a subpath of a dir</td></tr> <tr><td style="width: 25%;"><a href="os.html">is_unix</a></td> <td>Test for types of operating systems</td></tr> <tr><td style="width: 25%;"><a href="is_web_path.html">is_web_path</a></td> <td>Test if a path is a web path</td></tr> <tr><td style="width: 25%;"><a href="os.html">is_windows</a></td> <td>Test for types of operating systems</td></tr> </table> <h2><a id="J">-- J --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="tojson.html">json_vector</a></td> <td>A simple JSON serializer</td></tr> </table> <h2><a id="L">-- L --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="pkg_attach.html">loadable</a></td> <td>Attach or load packages, and automatically install missing packages if requested</td></tr> </table> <h2><a id="M">-- M --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="magic_path.html">magic_path</a></td> <td>Find a file or directory under a root directory</td></tr> <tr><td style="width: 25%;"><a href="mark_dirs.html">mark_dirs</a></td> <td>Mark some paths as directories</td></tr> <tr><td style="width: 25%;"><a href="msg_cat.html">msg_cat</a></td> <td>Generate a message with 'cat()'</td></tr> </table> <h2><a id="N">-- N --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="numbers_to_words.html">n2w</a></td> <td>Convert numbers to English words</td></tr> <tr><td style="width: 25%;"><a href="native_encode.html">native_encode</a></td> <td>Try to use the system native encoding to represent a character vector</td></tr> <tr><td style="width: 25%;"><a href="news2md.html">news2md</a></td> <td>Convert package news to the Markdown format</td></tr> <tr><td style="width: 25%;"><a href="normalize_path.html">normalize_path</a></td> <td>Normalize paths</td></tr> <tr><td style="width: 25%;"><a href="numbers_to_words.html">numbers_to_words</a></td> <td>Convert numbers to English words</td></tr> </table> <h2><a id="O">-- O --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="optipng.html">optipng</a></td> <td>Run OptiPNG on all PNG files under a directory</td></tr> </table> <h2><a id="P">-- P --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="parse_only.html">parse_only</a></td> <td>Parse R code and do not keep the source</td></tr> <tr><td style="width: 25%;"><a href="pkg_attach.html">pkg_attach</a></td> <td>Attach or load packages, and automatically install missing packages if requested</td></tr> <tr><td style="width: 25%;"><a href="pkg_attach.html">pkg_attach2</a></td> <td>Attach or load packages, and automatically install missing packages if requested</td></tr> <tr><td style="width: 25%;"><a href="pkg_attach.html">pkg_available</a></td> <td>Attach or load packages, and automatically install missing packages if requested</td></tr> <tr><td style="width: 25%;"><a href="pkg_attach.html">pkg_load</a></td> <td>Attach or load packages, and automatically install missing packages if requested</td></tr> <tr><td style="width: 25%;"><a href="pkg_attach.html">pkg_load2</a></td> <td>Attach or load packages, and automatically install missing packages if requested</td></tr> <tr><td style="width: 25%;"><a href="raw_string.html">print.xfun_raw_string</a></td> <td>Print a character vector in its raw form</td></tr> <tr><td style="width: 25%;"><a href="strict_list.html">print.xfun_strict_list</a></td> <td>Strict lists</td></tr> <tr><td style="width: 25%;"><a href="process_file.html">process_file</a></td> <td>Read a text file, process the text with a function, and write the text back</td></tr> <tr><td style="width: 25%;"><a href="proc_kill.html">proc_kill</a></td> <td>Kill a process and (optionally) all its child processes</td></tr> <tr><td style="width: 25%;"><a href="proj_root.html">proj_root</a></td> <td>Return the (possible) root directory of a project</td></tr> <tr><td style="width: 25%;"><a href="prose_index.html">prose_index</a></td> <td>Find the indices of lines in Markdown that are prose (not code blocks)</td></tr> <tr><td style="width: 25%;"><a href="protect_math.html">protect_math</a></td> <td>Protect math expressions in pairs of backticks in Markdown</td></tr> </table> <h2><a id="R">-- R --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="raw_string.html">raw_string</a></td> <td>Print a character vector in its raw form</td></tr> <tr><td style="width: 25%;"><a href="Rscript.html">Rcmd</a></td> <td>Run the commands 'Rscript' and 'R CMD'</td></tr> <tr><td style="width: 25%;"><a href="read_all.html">read_all</a></td> <td>Read all text files and concatenate their content</td></tr> <tr><td style="width: 25%;"><a href="read_bin.html">read_bin</a></td> <td>Read all records of a binary file as a raw vector by default</td></tr> <tr><td style="width: 25%;"><a href="read_utf8.html">read_utf8</a></td> <td>Read / write files encoded in UTF-8</td></tr> <tr><td style="width: 25%;"><a href="relative_path.html">relative_path</a></td> <td>Get the relative path of a path relative to a directory</td></tr> <tr><td style="width: 25%;"><a href="rename_seq.html">rename_seq</a></td> <td>Rename files with a sequential numeric prefix</td></tr> <tr><td style="width: 25%;"><a href="rest_api.html">rest_api</a></td> <td>Get data from a REST API</td></tr> <tr><td style="width: 25%;"><a href="rest_api.html">rest_api_raw</a></td> <td>Get data from a REST API</td></tr> <tr><td style="width: 25%;"><a href="retry.html">retry</a></td> <td>Retry calling a function for a number of times</td></tr> <tr><td style="width: 25%;"><a href="rev_check.html">rev_check</a></td> <td>Run 'R CMD check' on the reverse dependencies of a package</td></tr> <tr><td style="width: 25%;"><a href="proj_root.html">root_rules</a></td> <td>Return the (possible) root directory of a project</td></tr> <tr><td style="width: 25%;"><a href="Rscript.html">Rscript</a></td> <td>Run the commands 'Rscript' and 'R CMD'</td></tr> <tr><td style="width: 25%;"><a href="Rscript_call.html">Rscript_call</a></td> <td>Call a function in a new R session via 'Rscript()'</td></tr> <tr><td style="width: 25%;"><a href="rstudio_type.html">rstudio_type</a></td> <td>Type a character vector into the RStudio source editor</td></tr> </table> <h2><a id="S">-- S --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="same_path.html">same_path</a></td> <td>Test if two paths are the same after they are normalized</td></tr> <tr><td style="width: 25%;"><a href="file_ext.html">sans_ext</a></td> <td>Manipulate filename extensions</td></tr> <tr><td style="width: 25%;"><a href="session_info.html">session_info</a></td> <td>An alternative to sessionInfo() to print session information</td></tr> <tr><td style="width: 25%;"><a href="set_envvar.html">set_envvar</a></td> <td>Set environment variables</td></tr> <tr><td style="width: 25%;"><a href="shrink_images.html">shrink_images</a></td> <td>Shrink images to a maximum width</td></tr> <tr><td style="width: 25%;"><a href="process_file.html">sort_file</a></td> <td>Read a text file, process the text with a function, and write the text back</td></tr> <tr><td style="width: 25%;"><a href="split_lines.html">split_lines</a></td> <td>Split a character vector by line breaks</td></tr> <tr><td style="width: 25%;"><a href="split_source.html">split_source</a></td> <td>Split source lines into complete expressions</td></tr> <tr><td style="width: 25%;"><a href="strict_list.html">strict_list</a></td> <td>Strict lists</td></tr> <tr><td style="width: 25%;"><a href="strip_html.html">strip_html</a></td> <td>Strip HTML tags</td></tr> <tr><td style="width: 25%;"><a href="submit_cran.html">submit_cran</a></td> <td>Submit a source package to CRAN</td></tr> <tr><td style="width: 25%;"><a href="system3.html">system3</a></td> <td>Run 'system2()' and mark its character output as UTF-8 if appropriate</td></tr> </table> <h2><a id="T">-- T --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="tinify.html">tinify</a></td> <td>Use the Tinify API to compress PNG and JPEG images</td></tr> <tr><td style="width: 25%;"><a href="tinify.html">tinify_dir</a></td> <td>Use the Tinify API to compress PNG and JPEG images</td></tr> <tr><td style="width: 25%;"><a href="tojson.html">tojson</a></td> <td>A simple JSON serializer</td></tr> <tr><td style="width: 25%;"><a href="tree.html">tree</a></td> <td>Turn the output of 'str()' into a tree diagram</td></tr> <tr><td style="width: 25%;"><a href="try_error.html">try_error</a></td> <td>Try an expression and see if it throws an error</td></tr> <tr><td style="width: 25%;"><a href="try_silent.html">try_silent</a></td> <td>Try to evaluate an expression silently</td></tr> </table> <h2><a id="U">-- U --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="upload_ftp.html">upload_ftp</a></td> <td>Upload to an FTP server via 'curl'</td></tr> <tr><td style="width: 25%;"><a href="upload_ftp.html">upload_win_builder</a></td> <td>Upload to an FTP server via 'curl'</td></tr> <tr><td style="width: 25%;"><a href="url_accessible.html">url_accessible</a></td> <td>Test if a URL is accessible</td></tr> <tr><td style="width: 25%;"><a href="url_filename.html">url_filename</a></td> <td>Extract filenames from a URLs</td></tr> </table> <h2><a id="V">-- V --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="valid_syntax.html">valid_syntax</a></td> <td>Check if the syntax of the code is valid</td></tr> </table> <h2><a id="W">-- W --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="file_ext.html">with_ext</a></td> <td>Manipulate filename extensions</td></tr> <tr><td style="width: 25%;"><a href="read_utf8.html">write_utf8</a></td> <td>Read / write files encoded in UTF-8</td></tr> </table> <h2><a id="Y">-- Y --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="yaml_body.html">yaml_body</a></td> <td>Partition the YAML metadata and the body in a document</td></tr> <tr><td style="width: 25%;"><a href="yaml_load.html">yaml_load</a></td> <td>Read YAML data</td></tr> </table> <h2><a id="misc">-- misc --</a></h2> <table style="width: 100%;"> <tr><td style="width: 25%;"><a href="strict_list.html">$.xfun_strict_list</a></td> <td>Strict lists</td></tr> </table> </div></body></html>