Rev 88966 | Blame | Compare with Previous | Last modification | View Log | Download | RSS feed
R Under development (unstable) (2025-10-22 r88964) -- "Unsuffered Consequences"Copyright (C) 2025 The R Foundation for Statistical ComputingPlatform: x86_64-pc-linux-gnuR is free software and comes with ABSOLUTELY NO WARRANTY.You are welcome to redistribute it under certain conditions.Type 'license()' or 'licence()' for distribution details.R is a collaborative project with many contributors.Type 'contributors()' for more information and'citation()' on how to cite R or R packages in publications.Type 'demo()' for some demos, 'help()' for on-line help, or'help.start()' for an HTML browser interface to help.Type 'q()' to quit R.> pkgname <- "tools"> source(file.path(R.home("share"), "R", "examples-header.R"))> options(warn = 1)> library('tools')>> base::assign(".oldSearch", base::search(), pos = 'CheckExEnv')> base::assign(".old_wd", base::getwd(), pos = 'CheckExEnv')> cleanEx()> nameEx("CRANtools")> ### * CRANtools>> flush(stderr()); flush(stdout())>> ### Name: CRANtools> ### Title: CRAN Package Repository Tools> ### Aliases: CRAN_package_db CRAN_check_results CRAN_check_details> ### CRAN_check_issues summarize_CRAN_check_status R_CRAN_WEB R_CRAN_SRC> ### CRAN_current_db CRAN_aliases_db CRAN_rdxrefs_db CRAN_archive_db> ### CRAN_authors_db>> ### ** Examples>>> cleanEx()> nameEx("HTMLheader")> ### * HTMLheader>> flush(stderr()); flush(stdout())>> ### Name: HTMLheader> ### Title: Generate a Standard HTML Header for R Help> ### Aliases: HTMLheader> ### Keywords: utilities documentation>> ### ** Examples>> cat(HTMLheader("This is a sample header"), sep="\n")<!DOCTYPE html><html><head><title>R: This is a sample header</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="/doc/html/R.css"></head><body><div class="container"><h1> This is a sample header<img class="toplogo" src="/doc/html/Rlogo.svg" alt="[R logo]"></h1><hr><div style="text-align: center;"><a href="/doc/html/index.html"><img class="arrow" src="/doc/html/up.jpg" alt="[Top]"></a></div>>>>> cleanEx()> nameEx("R")> ### * R>> flush(stderr()); flush(stdout())>> ### Name: R> ### Title: Call Function in Inferior R Process> ### Aliases: R>> ### ** Examples>> ## Compute cos(0) in an inferior R process.> ## By default, only return the value of the function call.> R(cos, list(0))[1] 1> ## If 'drop = FALSE', we also get status, stdout and stderr.> ## IGNORE_RDIFF_BEGIN> R(cos, list(0), drop = FALSE)$value[1] 1$status[1] 0$stdout[1] ""[2] "R Under development (unstable) (2025-10-22 r88964) -- \"Unsuffered Consequences\""[3] "Copyright (C) 2025 The R Foundation for Statistical Computing"[4] "Platform: x86_64-pc-linux-gnu"[5] ""[6] "R is free software and comes with ABSOLUTELY NO WARRANTY."[7] "You are welcome to redistribute it under certain conditions."[8] "Type 'license()' or 'licence()' for distribution details."[9] ""[10] "R is a collaborative project with many contributors."[11] "Type 'contributors()' for more information and"[12] "'citation()' on how to cite R or R packages in publications."[13] ""[14] "Type 'demo()' for some demos, 'help()' for on-line help, or"[15] "'help.start()' for an HTML browser interface to help."[16] "Type 'q()' to quit R."[17] ""[18] "> x <- readRDS(\"/tmp/RtmpjrnqE8/runri2309077fd2bc56\")"[19] "> options(repos = x$repos)"[20] "> y <- tryCatch(list(do.call(x$fun, x$args, quote = TRUE)), error = identity)"[21] "> saveRDS(y, \"/tmp/RtmpjrnqE8/runro230907d287351\")"[22] "> "$stderrcharacter(0)> ## IGNORE_RDIFF_END>>> ## A call giving an error:> (e <- tryCatch(R(stop, list("FOOBAR")), error = identity))<inferiorCallError: error in inferior call:FOOBAR>> ## The inferior R process ran successfully:> e$status[1] 0> ## The function call gave an error:> e$value<simpleError in do.call(x$fun, x$args, quote = TRUE): FOOBAR>>>>> cleanEx()> nameEx("Rd2HTML")> ### * Rd2HTML>> flush(stderr()); flush(stdout())>> ### Name: Rd2HTML> ### Title: Rd Converters> ### Aliases: Rd2txt Rd2HTML Rd2ex Rd2latex> ### Keywords: documentation>> ### ** Examples>>> cleanEx()> nameEx("Rd2txt_options")> ### * Rd2txt_options>> flush(stderr()); flush(stdout())>> ### Name: Rd2txt_options> ### Title: Set Formatting Options for Text Help> ### Aliases: Rd2txt_options> ### Keywords: documentation>> ### ** Examples>> saveOpts <- Rd2txt_options()> Rd2txt_options(minIndent = 4)> Rd2txt_options()[["minIndent"]][1] 4> Rd2txt_options(saveOpts)> stopifnot(identical(Rd2txt_options(), saveOpts))>>>> cleanEx()> nameEx("Rdutils")> ### * Rdutils>> flush(stderr()); flush(stdout())>> ### Name: Rdutils> ### Title: Rd Utilities> ### Aliases: Rd_db> ### Keywords: utilities documentation>> ### ** Examples>>> cleanEx()> nameEx("assertCondition")> ### * assertCondition>> flush(stderr()); flush(stdout())>> ### Name: assertCondition> ### Title: Asserting Error Conditions> ### Aliases: assertCondition assertWarning assertError> ### Keywords: programming error>> ### ** Examples>> assertError(sqrt("abc"))> assertWarning(matrix(1:8, 4,3))>> assertCondition( ""-1 ) # ok, any condition would satisfy this>> try( assertCondition(sqrt(2), "warning") )Error in assertCondition(sqrt(2), "warning") :Failed to get warning in evaluating sqrt(2)> ## .. Failed to get warning in evaluating sqrt(2)> assertCondition(sqrt("abc"), "error") # ok> try( assertCondition(sqrt("abc"), "warning") )# -> error: had no warningError in assertCondition(sqrt("abc"), "warning") :Got simpleError in evaluating sqrt("abc"); wanted warning> assertCondition(sqrt("abc"), "error")> ## identical to assertError() call above>> assertCondition(matrix(1:5, 2,3), "warning")> try( assertCondition(matrix(1:8, 4,3), "error") )Error in assertCondition(matrix(1:8, 4, 3), "error") :Got simpleWarning in evaluating matrix(1:8, 4, 3); wanted error> ## .. Failed to get expected error ....>> ## either warning or worse:> assertCondition(matrix(1:8, 4,3), "error","warning") # OK> assertCondition(matrix(1:8, 4, 3), "warning") # OK>> ## when both are signalled:> ff <- function() { warning("my warning"); stop("my error") }> assertCondition(ff(), "warning")> ## but assertWarning does not allow an error to follow> try(assertWarning(ff()))Error in assertWarning(ff()) :Got warning in evaluating ff(), but also an error> assertCondition(ff(), "error") # ok> assertCondition(ff(), "error", "warning") # ok (quietly, catching warning)>> ## assert that assertC..() does not assert [and use *one* argument only]> assertCondition( assertCondition(sqrt( 2 ), "warning") )> assertCondition( assertCondition(sqrt("abc"), "warning"), "error")> assertCondition( assertCondition(matrix(1:8, 4,3), "error"),+ "error")>>>> cleanEx()> nameEx("bibstyle")> ### * bibstyle>> flush(stderr()); flush(stdout())>> ### Name: bibstyle> ### Title: Select or Define a Bibliography Style> ### Aliases: bibstyle getBibstyle> ### Keywords: utilities documentation>> ### ** Examples>> refs <-+ c(bibentry(bibtype = "manual",+ title = "R: A Language and Environment for Statistical Computing",+ author = person("R Core Team"),+ organization = "R Foundation for Statistical Computing",+ address = "Vienna, Austria",+ year = 2013,+ url = "https://www.R-project.org"),+ bibentry(bibtype = "article",+ author = c(person(c("George", "Edward", "Pelham"), "Box"),+ person(c("David", "Roxbee"), "Cox")),+ year = 1964,+ title = "An Analysis of Transformations",+ journal = "Journal of the Royal Statistical Society, Series B",+ volume = 26, number = 2, pages = "211--243",+ doi = "10.1111/j.2517-6161.1964.tb00553.x"))>> bibstyle("unsorted", sortKeys = function(refs) seq_along(refs),+ fmtPrefix = function(paper) paste0("[", paper$.index, "]"),+ .init = TRUE)<environment: 0x55a759bc34c8>> print(refs, .bibstyle = "unsorted")[1] R Core Team (2013). _R: A Language and Environment for StatisticalComputing_. R Foundation for Statistical Computing, Vienna, Austria.<https://www.R-project.org>.[2] Box GEP, Cox DR (1964). “An Analysis of Transformations.” _Journalof the Royal Statistical Society, Series B_, *26*(2), 211-243.doi:10.1111/j.2517-6161.1964.tb00553.x<https://doi.org/10.1111/j.2517-6161.1964.tb00553.x>.>>>> cleanEx()> nameEx("buildVignettes")> ### * buildVignettes>> flush(stderr()); flush(stdout())>> ### Name: buildVignettes> ### Title: List and Build Package Vignettes> ### Aliases: buildVignettes pkgVignettes> ### Keywords: utilities documentation>> ### ** Examples>> gVigns <- pkgVignettes("grid")>>>> cleanEx()> nameEx("charsets")> ### * charsets>> flush(stderr()); flush(stdout())>> ### Name: charsets> ### Title: Conversion Tables between Character Sets> ### Aliases: Adobe_glyphs charset_to_Unicode> ### Keywords: datasets>> ### ** Examples>> ## find Adobe names for ISOLatin2 chars.> latin2 <- charset_to_Unicode[, "ISOLatin2"]> aUnicode <- as.hexmode(paste0("0x", Adobe_glyphs$unicode))> keep <- aUnicode %in% latin2> aUnicode <- aUnicode[keep]> aAdobe <- Adobe_glyphs[keep, 1]> ## first match> aLatin2 <- aAdobe[match(latin2, aUnicode)]> ## all matches> bLatin2 <- lapply(1:256, function(x) aAdobe[aUnicode == latin2[x]])> format(bLatin2, justify = "none")[1] "" "controlSTX"[3] "controlSOT" "controlETX"[5] "controlEOT" "controlENQ"[7] "controlACK" "controlBEL"[9] "controlBS" "controlHT"[11] "controlLF" "controlVT"[13] "controlFF" "controlCR"[15] "controlSO" "controlSI"[17] "controlDLE" "controlDC1"[19] "controlDC2" "controlDC3"[21] "controlDC4" "controlNAK"[23] "controlSYN" "controlETB"[25] "controlCAN" "controlEM"[27] "controlSUB" "controlESC"[29] "controlFS" "controlGS"[31] "controlRS" "controlUS"[33] "space, spacehackarabic" "exclam"[35] "quotedbl" "numbersign"[37] "dollar" "percent"[39] "ampersand" "quotesingle"[41] "parenleft" "parenright"[43] "asterisk" "plus"[45] "comma" "hyphen"[47] "period" "slash"[49] "zero" "one"[51] "two" "three"[53] "four" "five"[55] "six" "seven"[57] "eight" "nine"[59] "colon" "semicolon"[61] "less" "equal"[63] "greater" "question"[65] "at" "A"[67] "B" "C"[69] "D" "E"[71] "F" "G"[73] "H" "I"[75] "J" "K"[77] "L" "M"[79] "N" "O"[81] "P" "Q"[83] "R" "S"[85] "T" "U"[87] "V" "W"[89] "X" "Y"[91] "Z" "bracketleft"[93] "backslash" "bracketright"[95] "asciicircum" "underscore"[97] "grave" "a"[99] "b" "c"[101] "d" "e"[103] "f" "g"[105] "h" "i"[107] "j" "k"[109] "l" "m"[111] "n" "o"[113] "p" "q"[115] "r" "s"[117] "t" "u"[119] "v" "w"[121] "x" "y"[123] "z" "braceleft"[125] "bar, verticalbar" "braceright"[127] "asciitilde" "controlDEL"[129] "" ""[131] "" ""[133] "" ""[135] "" ""[137] "" ""[139] "" ""[141] "" ""[143] "" ""[145] "" ""[147] "" ""[149] "" ""[151] "" ""[153] "" ""[155] "" ""[157] "" ""[159] "" ""[161] "nbspace, nonbreakingspace" "Aogonek"[163] "breve" "Lslash"[165] "currency" "Lcaron"[167] "Sacute" "section"[169] "dieresis" "Scaron"[171] "Scedilla" "Tcaron"[173] "Zacute" "sfthyphen, softhyphen"[175] "Zcaron" "Zdot, Zdotaccent"[177] "degree" "aogonek"[179] "ogonek" "lslash"[181] "acute" "lcaron"[183] "sacute" "caron"[185] "cedilla" "scaron"[187] "scedilla" "tcaron"[189] "zacute" "hungarumlaut"[191] "zcaron" "zdot, zdotaccent"[193] "Racute" "Aacute"[195] "Acircumflex" "Abreve"[197] "Adieresis" "Lacute"[199] "Cacute" "Ccedilla"[201] "Ccaron" "Eacute"[203] "Eogonek" "Edieresis"[205] "Ecaron" "Iacute"[207] "Icircumflex" "Dcaron"[209] "Dcroat, Dslash" "Nacute"[211] "Ncaron" "Oacute"[213] "Ocircumflex" "Odblacute, Ohungarumlaut"[215] "Odieresis" "multiply"[217] "Rcaron" "Uring"[219] "Uacute" "Udblacute, Uhungarumlaut"[221] "Udieresis" "Yacute"[223] "Tcedilla, Tcommaaccent" "germandbls"[225] "racute" "aacute"[227] "acircumflex" "abreve"[229] "adieresis" "lacute"[231] "cacute" "ccedilla"[233] "ccaron" "eacute"[235] "eogonek" "edieresis"[237] "ecaron" "iacute"[239] "icircumflex" "dcaron"[241] "dcroat, dmacron" "nacute"[243] "ncaron" "oacute"[245] "ocircumflex" "odblacute, ohungarumlaut"[247] "odieresis" "divide"[249] "rcaron" "uring"[251] "uacute" "udblacute, uhungarumlaut"[253] "udieresis" "yacute"[255] "tcedilla, tcommaaccent" "dotaccent">>>> cleanEx()> nameEx("checkFF")> ### * checkFF>> flush(stderr()); flush(stdout())>> ### Name: checkFF> ### Title: Check Foreign Function Calls> ### Aliases: checkFF print.checkFF> ### Keywords: programming utilities>> ### ** Examples>>> cleanEx()> nameEx("checkPoFiles")> ### * checkPoFiles>> flush(stderr()); flush(stdout())>> ### Name: checkPoFiles> ### Title: Check Translation Files for Inconsistent Format Strings> ### Aliases: checkPoFile checkPoFiles> ### Keywords: utilities>> ### ** Examples>> ## Not run:> ##D checkPoFiles("de", "/path/to/R/src/directory")> ## End(Not run)>>>> cleanEx()> nameEx("checkRd")> ### * checkRd>> flush(stderr()); flush(stdout())>> ### Name: checkRd> ### Title: Check an Rd Object> ### Aliases: checkRd> ### Keywords: utilities documentation>> ### ** Examples>> ## parsed Rd from the installed version of _this_ help file> rd <- Rd_db("tools")[["checkRd.Rd"]]> stopifnot(length(checkRd(rd)) == 0) # there should be no issues>> ## make up \tabular issues> bad <- r"(\name{bad}\title{bad}\description{\tabular{p}{1 \tab 2}})"> (res <- checkRd(parse_Rd(textConnection(bad))))checkRd: (7) <connection>:1: Unrecognized \tabular format: pcheckRd: (7) <connection>:1: Only 1 column allowed in this table (row 1 has 2)> stopifnot(length(res) > 0)>>>> cleanEx()> nameEx("checkRdaFiles")> ### * checkRdaFiles>> flush(stderr()); flush(stdout())>> ### Name: checkRdaFiles> ### Title: Report on Details of Saved Images or Re-saves them> ### Aliases: checkRdaFiles resaveRdaFiles> ### Keywords: utilities>> ### ** Examples> ## Not run:> ##D ## from a package top-level source directory> ##D paths <- sort(Sys.glob(c("data/*.rda", "data/*.RData")))> ##D (res <- checkRdaFiles(paths))> ##D ## pick out some that may need attention> ##D bad <- is.na(res$ASCII) | res$ASCII | (res$size > 1e4 & res$compress == "none")> ##D res[bad, ]> ## End(Not run)>>> cleanEx()> nameEx("check_packages_in_dir")> ### * check_packages_in_dir>> flush(stderr()); flush(stdout())>> ### Name: check_packages_in_dir> ### Title: Check Source Packages and Their Reverse Dependencies> ### Aliases: check_packages_in_dir summarize_check_packages_in_dir_depends> ### summarize_check_packages_in_dir_results> ### summarize_check_packages_in_dir_timings check_packages_in_dir_changes> ### check_packages_in_dir_details> ### Keywords: utilities>> ### ** Examples>> ## Not run:> ##D ## Check packages in dir without reverse dependencies:> ##D check_packages_in_dir(dir)> ##D ## Check packages in dir and their reverse dependencies using the> ##D ## defaults (all repositories in getOption("repos"), all "strong"> ##D ## reverse dependencies, no recursive reverse dependencies):> ##D check_packages_in_dir(dir, reverse = list())> ##D ## Check packages in dir with their reverse dependencies from CRAN,> ##D ## using all strong reverse dependencies and reverse suggests:> ##D check_packages_in_dir(dir,> ##D reverse = list(repos = getOption("repos")["CRAN"],> ##D which = "most"))> ##D ## Check packages in dir with their reverse dependencies from CRAN,> ##D ## using '--as-cran' for the former but not the latter:> ##D check_packages_in_dir(dir,> ##D check_args = c("--as-cran", ""),> ##D reverse = list(repos = getOption("repos")["CRAN"]))> ## End(Not run)>>>> cleanEx()> nameEx("delimMatch")> ### * delimMatch>> flush(stderr()); flush(stdout())>> ### Name: delimMatch> ### Title: Delimited Pattern Matching> ### Aliases: delimMatch> ### Keywords: character>> ### ** Examples>> x <- c("\\value{foo}", "function(bar)")> delimMatch(x)[1] 7 -1attr(,"match.length")[1] 5 -1> delimMatch(x, c("(", ")"))[1] -1 9attr(,"match.length")[1] -1 5>>>> cleanEx()> nameEx("dependsOnPkgs")> ### * dependsOnPkgs>> flush(stderr()); flush(stdout())>> ### Name: dependsOnPkgs> ### Title: Find Reverse Dependencies> ### Aliases: dependsOnPkgs> ### Keywords: utilities>> ### ** Examples>>> cleanEx()> nameEx("encoded")> ### * encoded>> flush(stderr()); flush(stdout())>> ### Name: encoded_text_to_latex> ### Title: Translate non-ASCII Text to LaTeX Escapes> ### Aliases: encoded_text_to_latex> ### Keywords: utilities>> ### ** Examples>> x <- "fran\xE7ais"> encoded_text_to_latex(x, "latin1")[1] "fran{\\c c}ais"> ## Not run:> ##D ## create a tex file to show the upper half of 8-bit charsets> ##D x <- rawToChar(as.raw(160:255), multiple = TRUE)> ##D (x <- matrix(x, ncol = 16, byrow = TRUE))> ##D xx <- x> ##D xx[] <- encoded_text_to_latex(x, "latin1") # or latin2 or latin9> ##D xx <- apply(xx, 1, paste, collapse = "&")> ##D con <- file("test-encoding.tex", "w")> ##D header <- c(> ##D "\\documentclass{article}",> ##D "\\usepackage[T1]{fontenc}",> ##D "\\usepackage{Rd}",> ##D "\\begin{document}",> ##D "\\HeaderA{test}{}{test}",> ##D "\\begin{Details}\\relax",> ##D "\\Tabular{cccccccccccccccc}{")> ##D trailer <- c("}", "\\end{Details}", "\\end{document}")> ##D writeLines(header, con)> ##D writeLines(paste0(xx, "\\\\"), con)> ##D writeLines(trailer, con)> ##D close(con)> ##D ## and some UTF_8 chars> ##D x <- intToUtf8(as.integer(> ##D c(160:383,0x0192,0x02C6,0x02C7,0x02CA,0x02D8,> ##D 0x02D9, 0x02DD, 0x200C, 0x2018, 0x2019, 0x201C,> ##D 0x201D, 0x2020, 0x2022, 0x2026, 0x20AC)),> ##D multiple = TRUE)> ##D x <- matrix(x, ncol = 16, byrow = TRUE)> ##D xx <- x> ##D xx[] <- encoded_text_to_latex(x, "UTF-8")> ##D xx <- apply(xx, 1, paste, collapse = "&")> ##D con <- file("test-utf8.tex", "w")> ##D writeLines(header, con)> ##D writeLines(paste(xx, "\\\\", sep = ""), con)> ##D writeLines(trailer, con)> ##D close(con)> ## End(Not run)>>> cleanEx()> nameEx("fileutils")> ### * fileutils>> flush(stderr()); flush(stdout())>> ### Name: fileutils> ### Title: File Utilities> ### Aliases: file_ext file_path_as_absolute file_path_sans_ext> ### list_files_with_exts list_files_with_type> ### Keywords: file>> ### ** Examples>>> cleanEx()> nameEx("find_gs_cmd")> ### * find_gs_cmd>> flush(stderr()); flush(stdout())>> ### Name: find_gs_cmd> ### Title: Find a GhostScript Executable> ### Aliases: find_gs_cmd R_GSCMD GSC>> ### ** Examples> ## Not run:> ##D ## Suppose a Solaris system has GhostScript 9.00 on the path and> ##D ## 9.07 in /opt/csw/bin. Then one might set> ##D Sys.setenv(R_GSCMD = "/opt/csw/bin/gs")> ## End(Not run)>>> cleanEx()> nameEx("getVignetteInfo")> ### * getVignetteInfo>> flush(stderr()); flush(stdout())>> ### Name: getVignetteInfo> ### Title: Get Information on Installed Vignettes> ### Aliases: getVignetteInfo> ### Keywords: utilities documentation>> ### ** Examples>>>>> cleanEx()> nameEx("licensetools")> ### * licensetools>> flush(stderr()); flush(stdout())>> ### Name: licensetools> ### Title: License Tools> ### Aliases: analyze_license>> ### ** Examples>> ## Examples from section 'Licensing' of 'Writing R Extensions':> analyze_license("GPL-2")$is_empty[1] FALSE$is_canonical[1] TRUE$bad_componentscharacter(0)$is_standardizable[1] TRUE$is_verified[1] TRUE$standardization[1] "GPL-2"$components[1] "GPL-2"$expansions$expansions[[1]][1] "GPL-2"$extensionsNULL$pointersNULL$is_FOSS[1] TRUE$restricts_use[1] FALSE$spdx[1] "GPL-2.0-only"> analyze_license("LGPL (>= 2.0, < 3) | Mozilla Public License")$is_empty[1] FALSE$is_canonical[1] TRUE$bad_componentscharacter(0)$is_standardizable[1] TRUE$is_verified[1] TRUE$standardization[1] "LGPL (>= 2.0, < 3) | Mozilla Public License"$components[1] "LGPL (>= 2.0, < 3)" "Mozilla Public License"$expansions$expansions[[1]][1] "LGPL-2" "LGPL-2.1"$expansions[[2]][1] "MPL version 1.0" "MPL version 1.1" "MPL version 2.0"$extensionsNULL$pointersNULL$is_FOSS[1] TRUE$restricts_use[1] FALSE$spdx[1] "LGPL-2.0-only OR LGPL-2.1-only OR MPL-1.0 OR MPL-1.1 OR MPL-2.0"> analyze_license("GPL-2 | file LICENCE")$is_empty[1] FALSE$is_canonical[1] TRUE$bad_componentscharacter(0)$is_standardizable[1] TRUE$is_verified[1] TRUE$standardization[1] "GPL-2 | file LICENCE"$components[1] "GPL-2" "file LICENCE"$expansions$expansions[[1]][1] "GPL-2"$expansions[[2]][1] "file LICENCE"$extensionsNULL$pointers[1] "LICENCE"$is_FOSS[1] TRUE$restricts_use[1] FALSE$spdx[1] "GPL-2.0-only"> analyze_license("GPL (>= 2) | BSD_3_clause + file LICENSE")$is_empty[1] FALSE$is_canonical[1] TRUE$bad_componentscharacter(0)$is_standardizable[1] TRUE$is_verified[1] TRUE$standardization[1] "GPL (>= 2) | BSD_3_clause + file LICENSE"$components[1] "GPL (>= 2)" "BSD_3_clause + file LICENSE"$expansions$expansions[[1]][1] "GPL-2" "GPL-3"$expansions[[2]][1] "BSD_3_clause + file LICENSE"$extensionscomponents extensible1 BSD_3_clause + file LICENSE TRUE$pointers[1] "LICENSE"$is_FOSS[1] TRUE$restricts_use[1] FALSE$spdx[1] "GPL-2.0-only OR GPL-3.0-only OR BSD-3-Clause"> analyze_license("Artistic-2.0 | AGPL-3 + file LICENSE")$is_empty[1] FALSE$is_canonical[1] TRUE$bad_componentscharacter(0)$is_standardizable[1] TRUE$is_verified[1] TRUE$standardization[1] "Artistic-2.0 | AGPL-3 + file LICENSE"$components[1] "Artistic-2.0" "AGPL-3 + file LICENSE"$expansions$expansions[[1]][1] "Artistic-2.0"$expansions[[2]][1] "AGPL-3 + file LICENSE"$extensionscomponents extensible1 AGPL-3 + file LICENSE TRUE$pointers[1] "LICENSE"$is_FOSS[1] TRUE$restricts_use[1] FALSE$spdx[1] "Artistic-2.0 OR AGPL-3.0-only">>>> cleanEx()> nameEx("loadRdMacros")> ### * loadRdMacros>> flush(stderr()); flush(stdout())>> ### Name: loadRdMacros> ### Title: Load User-defined Rd Help System Macros> ### Aliases: loadRdMacros loadPkgRdMacros> ### Keywords: utilities documentation>> ### ** Examples>> f <- tempfile()> writeLines(r"(+ \newcommand{\Rlogo}{+ \if{html}{\figure{Rlogo.svg}{options: width=100 alt="R logo"}}+ \if{latex}{\figure{Rlogo.pdf}{options: width=0.5in}}+ }+ )", f)> m <- loadRdMacros(f)> ls(m)[1] "\\Rlogo"> ls(parent.env(parent.env(m)))character(0)> parse_Rd(textConnection(r"(\Rlogo)"), fragment = TRUE, macros = m)\if{html}{\figure{Rlogo.svg}{options: width=100 alt="R logo"}}\if{latex}{\figure{Rlogo.pdf}{options: width=0.5in}}>>>> cleanEx()> nameEx("makevars")> ### * makevars>> flush(stderr()); flush(stdout())>> ### Name: makevars> ### Title: User and Site Compilation Variables> ### Aliases: makevars_user makevars_site> ### Keywords: utilities>> ### ** Examples> ## Don't show:> checkMV <- function(r)+ stopifnot(is.character(r),+ length(r) == 0 || (length(r) == 1 && file.exists(r)))> checkMV(makevars_user())> checkMV(makevars_site())> ## End(Don't show)>>>> cleanEx()> nameEx("md5sum")> ### * md5sum>> flush(stderr()); flush(stdout())>> ### Name: md5sum> ### Title: Compute MD5 Checksums> ### Aliases: md5sum> ### Keywords: utilities>> ### ** Examples>> as.vector(md5sum(dir(R.home(), pattern = "^COPY", full.names = TRUE)))[1] "eb723b61539feef013de476e68b5c50a"> md5sum(bytes=raw())[1] "d41d8cd98f00b204e9800998ecf8427e"> md5sum(bytes=charToRaw("abc"))[1] "900150983cd24fb0d6963f7d28e17f72">>>> cleanEx()> nameEx("package_dependencies")> ### * package_dependencies>> flush(stderr()); flush(stdout())>> ### Name: package_dependencies> ### Title: Computations on the Dependency Hierarchy of Packages> ### Aliases: package_dependencies> ### Keywords: utilities>> ### ** Examples>>>>> cleanEx()> nameEx("package_native_routine_registration_skeleton")> ### * package_native_routine_registration_skeleton>> flush(stderr()); flush(stdout())>> ### Name: package_native_routine_registration_skeleton> ### Title: Write Skeleton for Adding Native Routine Registration to a> ### Package> ### Aliases: package_native_routine_registration_skeleton>> ### ** Examples> ## Not run:> ##D ## with a completed splines/DESCRIPTION file,> ##D tools::package_native_routine_registration_skeleton('splines',,,FALSE)> ##D ## produces> ##D #include <R.h>> ##D #include <Rinternals.h>> ##D #include <stdlib.h> // for NULL> ##D #include <R_ext/Rdynload.h>> ##D> ##D /* FIXME:> ##D Check these declarations against the C/Fortran source code.> ##D */> ##D> ##D /* .Call calls */> ##D extern SEXP spline_basis(SEXP, SEXP, SEXP, SEXP);> ##D extern SEXP spline_value(SEXP, SEXP, SEXP, SEXP, SEXP);> ##D> ##D static const R_CallMethodDef CallEntries[] = {> ##D {"spline_basis", (DL_FUNC) &spline_basis, 4},> ##D {"spline_value", (DL_FUNC) &spline_value, 5},> ##D {NULL, NULL, 0}> ##D };> ##D> ##D void R_init_splines(DllInfo *dll)> ##D {> ##D R_registerRoutines(dll, NULL, CallEntries, NULL, NULL);> ##D R_useDynamicSymbols(dll, FALSE);> ##D }> ## End(Not run)>>> cleanEx()> nameEx("parseLatex")> ### * parseLatex>> flush(stderr()); flush(stdout())>> ### Name: parseLatex> ### Title: Experimental Functions to Work with LaTeX Code> ### Aliases: parseLatex deparseLatex latexToUtf8> ### Keywords: utilities documentation>> ### ** Examples>> latex <- parseLatex("fran\\c{c}ais", verbose = TRUE)1:1: TEXT: fran1:5: MACRO: \c1:7: '{'1:8: TEXT: c1:9: '}'1:10: TEXT: ais1:13: END_OF_INPUT> ## IGNORE_RDIFF_BEGIN> deparseLatex(latexToUtf8(latex))[1] "français"> ## IGNORE_RDIFF_END>> deparseLatex(parseLatex("$t$"), math = c("\\eqn{", "}"))[1] "\\eqn{t}">>>> cleanEx()> nameEx("pkg2HTML")> ### * pkg2HTML>> flush(stderr()); flush(stdout())>> ### Name: pkg2HTML> ### Title: Rd Converters> ### Aliases: pkg2HTML> ### Keywords: documentation>> ### ** Examples>>>>> cleanEx()> nameEx("print.via.format")> ### * print.via.format>> flush(stderr()); flush(stdout())>> ### Name: .print.via.format> ### Title: Printing Utilities> ### Aliases: .print.via.format> ### Keywords: utilities>> ### ** Examples>> ## The function is simply defined as> function (x, ...) {+ writeLines(format(x, ...))+ invisible(x)+ }function (x, ...){writeLines(format(x, ...))invisible(x)}>> ## is used for simple print methods in R, and as prototype for new methods.>>>> cleanEx()> nameEx("pskill")> ### * pskill>> flush(stderr()); flush(stdout())>> ### Name: pskill> ### Title: Kill a Process> ### Aliases: pskill SIGHUP SIGINT SIGQUIT SIGKILL SIGTERM SIGSTOP SIGTSTP> ### SIGCONT SIGCHLD SIGUSR1 SIGUSR2> ### Keywords: utilities>> ### ** Examples> ## Not run:> ##D pskill(c(237, 245), SIGKILL)> ## End(Not run)>>> cleanEx()> nameEx("sha256sum")> ### * sha256sum>> flush(stderr()); flush(stdout())>> ### Name: sha256sum> ### Title: Compute SHA-256 Checksums> ### Aliases: sha256sum> ### Keywords: utilities>> ### ** Examples>> as.vector(sha256sum(dir(R.home(), pattern = "^COPY", full.names = TRUE)))[1] "e6d6a009505e345fe949e1310334fcb0747f28dae2856759de102ab66b722cb4"> sha256sum(bytes=raw())[1] "e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"> sha256sum(bytes=charToRaw("abc"))[1] "ba7816bf8f01cfea414140de5dae2223b00361a396177a9cb410ff61f20015ad">>>> cleanEx()> nameEx("showNonASCII")> ### * showNonASCII>> flush(stderr()); flush(stdout())>> ### Name: showNonASCII> ### Title: Pick Out Non-ASCII Characters> ### Aliases: showNonASCII showNonASCIIfile> ### Keywords: utilities>> ### ** Examples>> out <- c(+ "fran\xE7ais: test of showNonASCII():",+ "\\details{",+ " This is a good line",+ " This has an \xfcmlaut in it.",+ " OK again.",+ "}")> f <- tempfile()> cat(out, file = f, sep = "\n")>> ## IGNORE_RDIFF_BEGIN> showNonASCIIfile(f)1: fran<e7>ais: test of showNonASCII():4: This has an <fc>mlaut in it.> ## IGNORE_RDIFF_END> unlink(f)>>>> cleanEx()> nameEx("testInstalledPackage")> ### * testInstalledPackage>> flush(stderr()); flush(stdout())>> ### Name: testInstalledPackage> ### Title: Test Installed Packages> ### Aliases: testInstalledPackage testInstalledPackages testInstalledBasic> ### TEST_MC_CORES standard_package_names> ### Keywords: utilities>> ### ** Examples>> str(stPkgs <- standard_package_names())List of 2$ base : chr [1:14] "base" "tools" "utils" "grDevices" ...$ recommended: chr [1:15] "MASS" "lattice" "Matrix" "nlme" ...>>>> cleanEx()> nameEx("toHTML")> ### * toHTML>> flush(stderr()); flush(stdout())>> ### Name: toHTML> ### Title: Display an Object in HTML> ### Aliases: toHTML toHTML.packageIQR toHTML.news_db> ### Keywords: utilities documentation>> ### ** Examples>> cat(toHTML(demo(package = "base")), sep = "\n")<!DOCTYPE html><html><head><title>R: R</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="/doc/html/R.css"></head><body><div class="container"><h1> R<img class="toplogo" src="/doc/html/Rlogo.svg" alt="[R logo]"></h1><hr><div style="text-align: center;"><a href="/doc/html/index.html"><img class="arrow" src="/doc/html/up.jpg" alt="[Top]"></a></div><h2>Demos in package ‘base’</h2><table cols="2" style="width: 100%;"><tr><td style="text-align: left; vertical-align: top; width: 10%;">error.catching</td><td style="text-align: left; vertical-align: top; width: 90%;">More examples on catching and handling errors</td></tr><tr><td style="text-align: left; vertical-align: top; width: 10%;">is.things</td><td style="text-align: left; vertical-align: top; width: 90%;">Explore some properties of R objects and is.FOO() functions. Not for newbies!</td></tr><tr><td style="text-align: left; vertical-align: top; width: 10%;">recursion</td><td style="text-align: left; vertical-align: top; width: 90%;">Using recursion for adaptive integration</td></tr><tr><td style="text-align: left; vertical-align: top; width: 10%;">scoping</td><td style="text-align: left; vertical-align: top; width: 90%;">An illustration of lexical scoping.</td></tr></table><p></p></div></body></html>>>>> cleanEx()> nameEx("toTitleCase")> ### * toTitleCase>> flush(stderr()); flush(stdout())>> ### Name: toTitleCase> ### Title: Convert Titles to Title Case> ### Aliases: toTitleCase>> ### ** Examples>> toTitleCase("bayesian network modeling and analysis")[1] "Bayesian Network Modeling and Analysis"> toTitleCase("ensemble tool for predictions from species distribution models")[1] "Ensemble Tool for Predictions from Species Distribution Models"> ## Treatment after "-":> toTitleCase("small- and large-scale analysis") # lowercase "and"[1] "Small- and Large-Scale Analysis">> toTitleCase("a small fox is jumping") # "a Small Fox is .." (the 'a' may change)% i.e. BUG[1] "a Small Fox is Jumping"> toTitleCase("is a small fox jumping?") # "Is a Small Fox .." (fine)[1] "Is a Small Fox Jumping?"> ## After ":", start a new sentence> toTitleCase("a pangram: the quick brown fox jumps over the lazy dog")[1] "a Pangram: The Quick Brown Fox Jumps over the Lazy Dog"> toTitleCase("asking -- 'is a small fox jumping?'") # ".. -- Is a Small ..." (fine)[1] "Asking -- 'Is a Small Fox Jumping?'">>>> cleanEx()> nameEx("undoc")> ### * undoc>> flush(stderr()); flush(stdout())>> ### Name: undoc> ### Title: Find Undocumented Objects> ### Aliases: undoc print.undoc> ### Keywords: documentation>> ### ** Examples>> undoc("tools") # Undocumented objects in 'tools'>>>> cleanEx()> nameEx("updatePACKAGES")> ### * updatePACKAGES>> flush(stderr()); flush(stdout())>> ### Name: update_PACKAGES> ### Title: Update Existing PACKAGES Files> ### Aliases: update_PACKAGES> ### Keywords: file utilities>> ### ** Examples>> ## Not run:> ##D write_PACKAGES("c:/myFolder/myRepository") # on Windows> ##D update_PACKAGES("c:/myFolder/myRepository") # on Windows> ##D write_PACKAGES("/pub/RWin/bin/windows/contrib/2.9",> ##D type = "win.binary") # on Linux> ##D update_PACKAGES("/pub/RWin/bin/windows/contrib/2.9",> ##D type = "win.binary") # on Linux> ## End(Not run)>>> cleanEx()> nameEx("urltools")> ### * urltools>> flush(stderr()); flush(stdout())>> ### Name: urltools> ### Title: Check Package URLs> ### Aliases: check_package_urls parse_URI_reference> ### Keywords: utilities>> ### ** Examples>> ## Examples from RFC 3986.> parse_URI_reference(c("foo://example.com:8042/over/there?name=ferret#nose",+ "urn:example:animal:ferret:nose",+ "mailto:John.Doe@example.com",+ "tel:+1-816-555-1212"))scheme authority path query fragment1 foo example.com:8042 /over/there name=ferret nose2 urn example:animal:ferret:nose3 mailto John.Doe@example.com4 tel +1-816-555-1212>>>> cleanEx()> nameEx("userdir")> ### * userdir>> flush(stderr()); flush(stdout())>> ### Name: userdir> ### Title: R User Directories> ### Aliases: R_user_dir>> ### ** Examples> ## IGNORE_RDIFF_BEGIN> R_user_dir("FOO", "cache")[1] "/home/hornik/.cache/R/FOO">> ## Create one, platform agnostically, must work if <normal> :> (Rdb <- R_user_dir("base"))[1] "/home/hornik/.local/share/R/base"> if(newD <- !dir.exists(Rdb)) # should work user specifically:+ newD <- dir.create(Rdb, recursive=TRUE)> dir(Rdb) # typically emptycharacter(0)> if(newD) unlink(Rdb) # cleaning up>> list.files(R_user_dir("grid"), full.names = TRUE)character(0)> ## IGNORE_RDIFF_END>>> cleanEx()> nameEx("vignetteEngine")> ### * vignetteEngine>> flush(stderr()); flush(stdout())>> ### Name: vignetteEngine> ### Title: Set or Get a Vignette Processing Engine> ### Aliases: vignetteEngine> ### Keywords: utilities documentation>> ### ** Examples>> str(vignetteEngine("Sweave"))List of 6$ name : chr "Sweave"$ package: chr "utils"$ pattern: chr "[.][rRsS](nw|tex)$"$ weave :function (...)$ tangle :function (...)$ aspell :List of 2..$ filter : chr "Sweave"..$ control: chr "-t">>>> cleanEx()> nameEx("vignetteInfo")> ### * vignetteInfo>> flush(stderr()); flush(stdout())>> ### Name: vignetteInfo> ### Title: Basic Information about a Vignette> ### Aliases: vignetteInfo> ### Keywords: utilities>> ### ** Examples>> gridEx <- system.file("doc", "grid.Rnw", package = "grid")> vi <- vignetteInfo(gridEx)> str(vi)List of 5$ file : chr "grid.Rnw"$ title : chr "Introduction to grid"$ depends : chr(0)$ keywords: chr(0)$ engine : chr "utils::Sweave">>>> cleanEx()> nameEx("writePACKAGES")> ### * writePACKAGES>> flush(stderr()); flush(stdout())>> ### Name: write_PACKAGES> ### Title: Generate PACKAGES Files> ### Aliases: write_PACKAGES> ### Keywords: file utilities>> ### ** Examples>> ## Not run:> ##D write_PACKAGES("c:/myFolder/myRepository") # on Windows> ##D write_PACKAGES("/pub/RWin/bin/windows/contrib/2.9",> ##D type = "win.binary") # on Linux> ## End(Not run)>>> cleanEx()> nameEx("xgettext")> ### * xgettext>> flush(stderr()); flush(stdout())>> ### Name: xgettext> ### Title: Extract Translatable Messages from R Files in a Package> ### Aliases: xgettext xngettext xgettext2pot> ### Keywords: utilities>> ### ** Examples> ## Not run:> ##D ## in a source-directory build (not typical!) of R;> ##D ## otherwise, download and unpack the R sources, and replace> ##D ## R.home() by "<my_path_to_source_R>" :> ##D xgettext(file.path(R.home(), "src", "library", "splines"))> ## End(Not run)>> ## Create source package-like <tmp>/R/foo.R and get text from it:> tmpPkg <- tempdir()> tmpRDir <- file.path(tmpPkg, "R")> dir.create(tmpRDir, showWarnings = FALSE)> fnChar <- paste(sep = "\n",+ "foo <- function(x) {",+ " if (x < -1) stop('too small')",+ " # messages unduplicated (not so for ngettext)",+ " if (x < -.5) stop('too small')",+ " if (x < 0) {",+ " warning(",+ " 'sqrt(x) is', sqrt(as.complex(x)),",+ " ', which may be too small'",+ " )",+ " }",+ " # calls with domain=NA are skipped",+ " if (x == 0) cat(gettext('x is 0!\n', domain=NA))",+ " # gettext strings may be ignored due to 'outer' domain=NA",+ " if (x > 10) warning('x is ', gettextf('%.2f', x), domain=NA)",+ " # using a custom condition class",+ " if (x == 42)",+ " stop(errorCondition(gettext('needs Deep Thought'), class='myError'))",+ " x",+ "}")>> writeLines(fnChar, con = file.path(tmpRDir, "foo.R"))>> ## [[1]] : suppressing (tmpfile) name to make example Rdiff-able> xgettext(tmpPkg, asCall=TRUE )[[1]] # default; shows callstoo smallsqrt(x) issqrt(as.complex(x)), which may be too smallerrorCondition(gettext("needs Deep Thought"), class = "myError")> xgettext(tmpPkg, asCall=FALSE)[[1]] # doesn't ; but then ' %.2f 'too smallsqrt(x) is, which may be too small%.2fneeds Deep Thought>> unlink(tmpRDir, recursive=TRUE)>>>> ### * <FOOTER>> ###> cleanEx()> options(digits = 7L)> base::cat("Time elapsed: ", proc.time() - base::get("ptime", pos = 'CheckExEnv'),"\n")Time elapsed: 0.338 0.018 0.748 0.284 0.109> grDevices::dev.off()null device1> ###> ### Local variables: ***> ### mode: outline-minor ***> ### outline-regexp: "\\(> \\)?### [*]+" ***> ### End: ***> quit('no')