CINXE.COM
citation: Citing R and R Packages in Publications
<!DOCTYPE html> <html lang="en"> <head> <meta charset="utf-8"> <script async src="https://www.googletagmanager.com/gtag/js?id=G-LRSBGK4Q35"></script> <script> window.dataLayer = window.dataLayer || []; function gtag(){dataLayer.push(arguments);} gtag('js', new Date()); gtag('config', 'G-LRSBGK4Q35'); </script> <meta http-equiv="X-UA-Compatible" content="IE=edge"> <meta name="viewport" content="width=device-width, initial-scale=1, minimum-scale=1"> <meta property="og:title" content="citation: Citing R and R Packages in Publications" /> <link rel="icon" href="/favicon.ico"> <link rel="canonical" href="https://rdrr.io/r/utils/citation.html" /> <link rel="search" type="application/opensearchdescription+xml" title="R Package Documentation" href="/opensearch.xml" /> <!-- Hello from sg3 --> <title>citation: Citing R and R Packages in Publications</title> <!-- HTML5 shim and Respond.js IE8 support of HTML5 elements and media queries --> <!--[if lt IE 9]> <script src="https://oss.maxcdn.com/html5shiv/3.7.2/html5shiv.min.js"></script> <script src="https://oss.maxcdn.com/respond/1.4.2/respond.min.js"></script> <![endif]--> <link rel="stylesheet" href="/static/CACHE/css/eb650e70007d.css" type="text/css" /> <style> .hll { background-color: #ffffcc } .pyg-c { color: #408080; font-style: italic } /* Comment */ .pyg-err { border: 1px solid #FF0000 } /* Error */ .pyg-k { color: #008000; font-weight: bold } /* Keyword */ .pyg-o { color: #666666 } /* Operator */ .pyg-ch { color: #408080; font-style: italic } /* Comment.Hashbang */ .pyg-cm { color: #408080; font-style: italic } /* Comment.Multiline */ .pyg-cp { color: #BC7A00 } /* Comment.Preproc */ .pyg-cpf { color: #408080; font-style: italic } /* Comment.PreprocFile */ .pyg-c1 { color: #408080; font-style: italic } /* Comment.Single */ .pyg-cs { color: #408080; font-style: italic } /* Comment.Special */ .pyg-gd { color: #A00000 } /* Generic.Deleted */ .pyg-ge { font-style: italic } /* Generic.Emph */ .pyg-gr { color: #FF0000 } /* Generic.Error */ .pyg-gh { color: #000080; font-weight: bold } /* Generic.Heading */ .pyg-gi { color: #00A000 } /* Generic.Inserted */ .pyg-go { color: #888888 } /* Generic.Output */ .pyg-gp { color: #000080; font-weight: bold } /* Generic.Prompt */ .pyg-gs { font-weight: bold } /* Generic.Strong */ .pyg-gu { color: #800080; font-weight: bold } /* Generic.Subheading */ .pyg-gt { color: #0044DD } /* Generic.Traceback */ .pyg-kc { color: #008000; font-weight: bold } /* Keyword.Constant */ .pyg-kd { color: #008000; font-weight: bold } /* Keyword.Declaration */ .pyg-kn { color: #008000; font-weight: bold } /* Keyword.Namespace */ .pyg-kp { color: #008000 } /* Keyword.Pseudo */ .pyg-kr { color: #008000; font-weight: bold } /* Keyword.Reserved */ .pyg-kt { color: #B00040 } /* Keyword.Type */ .pyg-m { color: #666666 } /* Literal.Number */ .pyg-s { color: #BA2121 } /* Literal.String */ .pyg-na { color: #7D9029 } /* Name.Attribute */ .pyg-nb { color: #008000 } /* Name.Builtin */ .pyg-nc { color: #0000FF; font-weight: bold } /* Name.Class */ .pyg-no { color: #880000 } /* Name.Constant */ .pyg-nd { color: #AA22FF } /* Name.Decorator */ .pyg-ni { color: #999999; font-weight: bold } /* Name.Entity */ .pyg-ne { color: #D2413A; font-weight: bold } /* Name.Exception */ .pyg-nf { color: #0000FF } /* Name.Function */ .pyg-nl { color: #A0A000 } /* Name.Label */ .pyg-nn { color: #0000FF; font-weight: bold } /* Name.Namespace */ .pyg-nt { color: #008000; font-weight: bold } /* Name.Tag */ .pyg-nv { color: #19177C } /* Name.Variable */ .pyg-ow { color: #AA22FF; font-weight: bold } /* Operator.Word */ .pyg-w { color: #bbbbbb } /* Text.Whitespace */ .pyg-mb { color: #666666 } /* Literal.Number.Bin */ .pyg-mf { color: #666666 } /* Literal.Number.Float */ .pyg-mh { color: #666666 } /* Literal.Number.Hex */ .pyg-mi { color: #666666 } /* Literal.Number.Integer */ .pyg-mo { color: #666666 } /* Literal.Number.Oct */ .pyg-sa { color: #BA2121 } /* Literal.String.Affix */ .pyg-sb { color: #BA2121 } /* Literal.String.Backtick */ .pyg-sc { color: #BA2121 } /* Literal.String.Char */ .pyg-dl { color: #BA2121 } /* Literal.String.Delimiter */ .pyg-sd { color: #BA2121; font-style: italic } /* Literal.String.Doc */ .pyg-s2 { color: #BA2121 } /* Literal.String.Double */ .pyg-se { color: #BB6622; font-weight: bold } /* Literal.String.Escape */ .pyg-sh { color: #BA2121 } /* Literal.String.Heredoc */ .pyg-si { color: #BB6688; font-weight: bold } /* Literal.String.Interpol */ .pyg-sx { color: #008000 } /* Literal.String.Other */ .pyg-sr { color: #BB6688 } /* Literal.String.Regex */ .pyg-s1 { color: #BA2121 } /* Literal.String.Single */ .pyg-ss { color: #19177C } /* Literal.String.Symbol */ .pyg-bp { color: #008000 } /* Name.Builtin.Pseudo */ .pyg-fm { color: #0000FF } /* Name.Function.Magic */ .pyg-vc { color: #19177C } /* Name.Variable.Class */ .pyg-vg { color: #19177C } /* Name.Variable.Global */ .pyg-vi { color: #19177C } /* Name.Variable.Instance */ .pyg-vm { color: #19177C } /* Name.Variable.Magic */ .pyg-il { color: #666666 } /* Literal.Number.Integer.Long */ </style> </head> <body> <div class="ui darkblue top fixed inverted menu" role="navigation" itemscope itemtype="http://www.schema.org/SiteNavigationElement" style="height: 40px; z-index: 1000;"> <a class="ui header item " href="/">rdrr.io<!-- <small>R Package Documentation</small>--></a> <a class='ui item ' href="/find/" itemprop="url"><i class='search icon'></i><span itemprop="name">Find an R package</span></a> <a class='ui item active' href="/r/" itemprop="url"><i class='file text outline icon'></i> <span itemprop="name">R language docs</span></a> <a class='ui item ' href="/snippets/" itemprop="url"><i class='play icon'></i> <span itemprop="name">Run R in your browser</span></a> <div class='right menu'> <form class='item' method='GET' action='/search'> <div class='ui right action input'> <input type='text' placeholder='packages, doc text, code...' size='24' name='q'> <button type="submit" class="ui green icon button"><i class='search icon'></i></button> </div> </form> </div> </div> <div class='ui fluid container bc-row'> <div class='ui breadcrumb' itemscope itemtype="http://schema.org/BreadcrumbList"> <a class='section' href="/">Home</a> <div class='divider'> / </div> <span itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"> <a class='section' itemscope itemtype="http://schema.org/Thing" itemprop="item" id="https://rdrr.io/r/" href="/r/"> <span itemprop="name">R Documentation</span> </a> <meta itemprop="position" content="1" /> </span> <div class='divider'> / </div> <span itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem"> <a class='section' itemscope itemtype="http://schema.org/Thing" itemprop="item" id="https://rdrr.io/r/" href="/r/"> <span itemprop="name">utils</span> </a> <meta itemprop="position" content="2" /> </span> <div class='divider'> / </div> <span itemprop="itemListElement" itemscope itemtype="http://schema.org/ListItem" class="active section"> <a class='active section' itemscope itemtype="http://schema.org/Thing" itemprop="item" id="https://rdrr.io/r/utils/citation.html" href="https://rdrr.io/r/utils/citation.html"> <strong itemprop="name">citation</strong>: Citing R and R Packages in Publications </a> <meta itemprop="position" content="3" /></li> </span> </div> </div> <div class='ui stackable grid container'> <div class="eleven wide column"> <h1>citation: Citing R and R Packages in Publications</h1> <div class="container"> <table summary="page for citation" width="100%"><tr><td>citation</td><td style="text-align: right;">R Documentation</td></tr></table> <h2>Citing R and R Packages in Publications</h2> <h3>Description</h3> <p>How to cite <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> and <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> packages in publications. </p> <h3>Usage</h3> <pre> citation(package = "base", lib.loc = NULL, auto = NULL) readCitationFile(file, meta = NULL) </pre> <h3>Arguments</h3> <table summary="R argblock"> <tr valign="top"><td><code>package</code></td> <td> <p>a character string with the name of a single package. An error occurs if more than one package name is given.</p> </td></tr> <tr valign="top"><td><code>lib.loc</code></td> <td> <p>a character vector with path names of <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> libraries, or the directory containing the source for <code>package</code>, or <code>NULL</code>. The default value of <code>NULL</code> corresponds to all libraries currently known. If the default is used, the loaded packages are searched before the libraries.</p> </td></tr> <tr valign="top"><td><code>auto</code></td> <td> <p>a logical indicating whether the default citation auto-generated from the package ‘<span class="file">DESCRIPTION</span>’ metadata should be used or not, or <code>NULL</code> (default), indicating that a ‘<span class="file">CITATION</span>’ file is used if it exists, or an object of class <code>"packageDescription"</code> with package metadata (see below).</p> </td></tr> <tr valign="top"><td><code>file</code></td> <td> <p>a file name.</p> </td></tr> <tr valign="top"><td><code>meta</code></td> <td> <p>a list of package metadata as obtained by <code>packageDescription</code>, or <code>NULL</code> (the default).</p> </td></tr> </table> <h3>Details</h3> <p>The <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> core development team and the very active community of package authors have invested a lot of time and effort in creating <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> as it is today. Please give credit where credit is due and cite <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> and <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> packages when you use them for data analysis. </p> <p>Execute function <code>citation()</code> for information on how to cite the base R system in publications. If the name of a non-base package is given, the function either returns the information contained in the ‘<span class="file">CITATION</span>’ file of the package (using <code>readCitationFile</code> with <code>meta</code> equal to <code>packageDescription(package, lib.loc)</code>) or auto-generates citation information from the ‘<span class="file">DESCRIPTION</span>’ file. </p> <p>In <span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> >= 2.14.0, one can use a <span class="samp">Authors@R</span> field in ‘<span class="file">DESCRIPTION</span>’ to provide (<span style="font-family: Courier New, Courier; color: #666666;"><b>R</b></span> code giving) a <code>person</code> object with a refined, machine-readable description of the package “authors” (in particular specifying their precise roles). Only those with an author role will be included in the auto-generated citation. </p> <p>If only one reference is given, the print method for the object returned by <code>citation()</code> shows both a text version and a BibTeX entry for it, if a package has more than one reference then only the text versions are shown. The BibTeX versions can be obtained using function <code>toBibtex()</code> (see the examples below). </p> <p>The ‘<span class="file">CITATION</span>’ file of an R package should be placed in the ‘<span class="file">inst</span>’ subdirectory of the package source. The file is an R source file and may contain arbitrary R commands including conditionals and computations. Function <code>readCitationFile()</code> is used by <code>citation()</code> to extract the information in ‘<span class="file">CITATION</span>’ files. The file is <code>source()</code>ed by the R parser in a temporary environment and all resulting bibliographic objects (specifically, of class <code>"bibentry"</code>) are collected. </p> <p>Traditionally, the ‘<span class="file">CITATION</span>’ file contained zero or more calls to <code>citHeader</code>, then one or more calls to <code>citEntry</code>, and finally zero or more calls to <code>citFooter</code>, where in fact <code>citHeader</code> and <code>citFooter</code> are simply wrappers to <code>paste</code>, with their <code>...</code> argument passed on to <code>paste</code> as is. The <code>"bibentry"</code> class makes for improved representation and manipulation of bibliographic information (in fact, the old mechanism is implemented using the new one), and one can write ‘<span class="file">CITATION</span>’ files using the unified <code>bibentry</code> interface. </p> <p>One can include an auto-generated package citation in the ‘<span class="file">CITATION</span>’ file via <code>citation(auto = meta)</code>. </p> <p><code>readCitationFile</code> makes use of the <code>Encoding</code> element (if any) of <code>meta</code> to determine the encoding of the file. </p> <h3>Value</h3> <p>An object of class <code>"citation"</code>, inheriting from class <code>"bibentry"</code>; see there, notably for the <code>print</code> and <code>format</code> methods. </p> <h3>See Also</h3> <p><code>bibentry</code> </p> <h3>Examples</h3> <pre> ## the basic R reference citation() ## references for a package -- might not have these installed if(nchar(system.file(package = "lattice"))) citation("lattice") if(nchar(system.file(package = "foreign"))) citation("foreign") ## extract the bibtex entry from the return value x <- citation() toBibtex(x) ## A citation with more than one bibentry: cm <- tryCatch(citation("mgcv"), error = function(e) { warning("Recommended package 'mgcv' is not installed properly") stop(e$message) }) cm # short entries (2-3 lines each) print(cm, bibtex = TRUE) # each showing its bibtex code </pre> </div> <br /> </div> <div class="five wide column"> <div class='ui vertical fluid menu'> <div class='item only-desktop'> <ins class="adsbygoogle" style="display:block;min-width:120px;max-width:300px;width:100%;height:600px" data-ad-client="ca-pub-6535703173049909" data-ad-slot="9724778181" data-ad-format="vertical"></ins> </div> <div class='item only-mobile' style='height: 100px;'> <!-- rdrr-mobile-responsive --> <ins class="adsbygoogle" style="display:block" data-ad-client="ca-pub-6535703173049909" data-ad-slot="4915028187" data-ad-format="auto"></ins> </div> <a class='item' href='/r/'> <h4 class='ui header'> utils </h4> </a> <a class=' item' href="/r/utils/adist.html"> <strong>adist</strong>: Approximate String Distances </a> <a class=' item' href="/r/utils/alarm.html"> <strong>alarm</strong>: Alert the User </a> <a class=' item' href="/r/utils/apropos.html"> <strong>apropos</strong>: Find Objects by (Partial) Name </a> <a class=' item' href="/r/utils/aregexec.html"> <strong>aregexec</strong>: Approximate String Match Positions </a> <a class=' item' href="/r/utils/arrangeWindows.html"> <strong>arrangeWindows</strong>: Rearrange Windows on MS Windows </a> <a class=' item' href="/r/utils/askYesNo.html"> <strong>askYesNo</strong>: Ask a Yes/No Question </a> <a class=' item' href="/r/utils/aspell.html"> <strong>aspell</strong>: Spell Check Interface </a> <a class=' item' href="/r/utils/aspell-utils.html"> <strong>aspell-utils</strong>: Spell Check Utilities </a> <a class=' item' href="/r/utils/available.packages.html"> <strong>available.packages</strong>: List Available Packages at CRAN-like Repositories </a> <a class=' item' href="/r/utils/BATCH.html"> <strong>BATCH</strong>: Batch Execution of R </a> <a class=' item' href="/r/utils/bibentry.html"> <strong>bibentry</strong>: Bibliography Entries </a> <a class=' item' href="/r/utils/browseEnv.html"> <strong>browseEnv</strong>: Browse Objects in Environment </a> <a class=' item' href="/r/utils/browseURL.html"> <strong>browseURL</strong>: Load URL into an HTML Browser </a> <a class=' item' href="/r/utils/browseVignettes.html"> <strong>browseVignettes</strong>: List Vignettes in an HTML Browser </a> <a class=' item' href="/r/utils/bug.report.html"> <strong>bug.report</strong>: Send a Bug Report </a> <a class=' item' href="/r/utils/capture.output.html"> <strong>capture.output</strong>: Send Output to a Character String or File </a> <a class=' item' href="/r/utils/changedFiles.html"> <strong>changedFiles</strong>: Detect which Files Have Changed </a> <a class=' item' href="/r/utils/charClass.html"> <strong>charClass</strong>: Character Classification </a> <a class=' item' href="/r/utils/chooseBioCmirror.html"> <strong>chooseBioCmirror</strong>: Select a Bioconductor Mirror </a> <a class=' item' href="/r/utils/chooseCRANmirror.html"> <strong>chooseCRANmirror</strong>: Select a CRAN Mirror </a> <a class=' item' href="/r/utils/choose.dir.html"> <strong>choose.dir</strong>: Choose a Folder Interactively on MS Windows </a> <a class=' item' href="/r/utils/choose.files.html"> <strong>choose.files</strong>: Choose a List of Files Interactively on MS Windows </a> <a class='active item' href="/r/utils/citation.html"> <strong>citation</strong>: Citing R and R Packages in Publications </a> <a class=' item' href="/r/utils/cite.html"> <strong>cite</strong>: Cite a Bibliography Entry </a> <a class=' item' href="/r/utils/citEntry.html"> <strong>citEntry</strong>: Bibliography Entries (Older Interface) </a> <a class=' item' href="/r/utils/clipboard.html"> <strong>clipboard</strong>: Read/Write to/from the Clipboard in MS Windows </a> <a class=' item' href="/r/utils/close.socket.html"> <strong>close.socket</strong>: Close a Socket </a> <a class=' item' href="/r/utils/combn.html"> <strong>combn</strong>: Generate All Combinations of n Elements, Taken m at a Time </a> <a class=' item' href="/r/utils/compareVersion.html"> <strong>compareVersion</strong>: Compare Two Package Version Numbers </a> <a class=' item' href="/r/utils/COMPILE.html"> <strong>COMPILE</strong>: Compile Files for Use with R on Unix-alikes </a> <a class=' item' href="/r/utils/contrib.url.html"> <strong>contrib.url</strong>: Find Appropriate Paths in CRAN-like Repositories </a> <a class=' item' href="/r/utils/count.fields.html"> <strong>count.fields</strong>: Count the Number of Fields per Line </a> <a class=' item' href="/r/utils/create.post.html"> <strong>create.post</strong>: Ancillary Function for Preparing Emails and Postings </a> <a class=' item' href="/r/utils/data.html"> <strong>data</strong>: Data Sets </a> <a class=' item' href="/r/utils/dataentry.html"> <strong>dataentry</strong>: Spreadsheet Interface for Entering Data </a> <a class=' item' href="/r/utils/debugcall.html"> <strong>debugcall</strong>: Debug a Call </a> <a class=' item' href="/r/utils/debugger.html"> <strong>debugger</strong>: Post-Mortem Debugging </a> <a class=' item' href="/r/utils/demo.html"> <strong>demo</strong>: Demonstrations of R Functionality </a> <a class=' item' href="/r/utils/DLL.version.html"> <strong>DLL.version</strong>: DLL Version Information on MS Windows </a> <a class=' item' href="/r/utils/download.file.html"> <strong>download.file</strong>: Download File from the Internet </a> <a class=' item' href="/r/utils/download.packages.html"> <strong>download.packages</strong>: Download Packages from CRAN-like Repositories </a> <a class=' item' href="/r/utils/edit.html"> <strong>edit</strong>: Invoke a Text Editor </a> <a class=' item' href="/r/utils/edit.data.frame.html"> <strong>edit.data.frame</strong>: Edit Data Frames and Matrices </a> <a class=' item' href="/r/utils/example.html"> <strong>example</strong>: Run an Examples Section from the Online Help </a> <a class=' item' href="/r/utils/file.edit.html"> <strong>file.edit</strong>: Edit One or More Files </a> <a class=' item' href="/r/utils/filetest.html"> <strong>filetest</strong>: Shell-style Tests on Files </a> <a class=' item' href="/r/utils/findLineNum.html"> <strong>findLineNum</strong>: Find the Location of a Line of Source Code, or Set a... </a> <a class=' item' href="/r/utils/fix.html"> <strong>fix</strong>: Fix an Object </a> <a class=' item' href="/r/utils/flush.console.html"> <strong>flush.console</strong>: Flush Output to a Console </a> <a class=' item' href="/r/utils/format.html"> <strong>format</strong>: Format Unordered and Ordered Lists </a> <a class=' item' href="/r/utils/getAnywhere.html"> <strong>getAnywhere</strong>: Retrieve an R Object, Including from a Namespace </a> <a class=' item' href="/r/utils/getFromNamespace.html"> <strong>getFromNamespace</strong>: Utility Functions for Developing Namespaces </a> <a class=' item' href="/r/utils/getParseData.html"> <strong>getParseData</strong>: Get Detailed Parse Information from Object </a> <a class=' item' href="/r/utils/getS3method.html"> <strong>getS3method</strong>: Get an S3 Method </a> <a class=' item' href="/r/utils/getWindowsHandle.html"> <strong>getWindowsHandle</strong>: Get a Windows Handle </a> <a class=' item' href="/r/utils/getWindowsHandles.html"> <strong>getWindowsHandles</strong>: Get handles of Windows in the MS Windows RGui </a> <a class=' item' href="/r/utils/glob2rx.html"> <strong>glob2rx</strong>: Change Wildcard or Globbing Pattern into Regular Expression </a> <a class=' item' href="/r/utils/globalVariables.html"> <strong>globalVariables</strong>: Declarations Used in Checking a Package </a> <a class=' item' href="/r/utils/hasName.html"> <strong>hasName</strong>: Check for Name </a> <a class=' item' href="/r/utils/head.html"> <strong>head</strong>: Return the First or Last Parts of an Object </a> <a class=' item' href="/r/utils/help.html"> <strong>help</strong>: Documentation </a> <a class=' item' href="/r/utils/help.request.html"> <strong>help.request</strong>: Send a Post to R-help </a> <a class=' item' href="/r/utils/help.search.html"> <strong>help.search</strong>: Search the Help System </a> <a class=' item' href="/r/utils/help.start.html"> <strong>help.start</strong>: Hypertext Documentation </a> <a class=' item' href="/r/utils/hsearch-utils.html"> <strong>hsearch-utils</strong>: Help Search Utilities </a> <a class=' item' href="/r/utils/INSTALL.html"> <strong>INSTALL</strong>: Install Add-on Packages </a> <a class=' item' href="/r/utils/installed.packages.html"> <strong>installed.packages</strong>: Find Installed Packages </a> <a class=' item' href="/r/utils/install.packages.html"> <strong>install.packages</strong>: Install Packages from Repositories or Local Files </a> <a class=' item' href="/r/utils/isS3method.html"> <strong>isS3method</strong>: Is 'method' the Name of an S3 Method? </a> <a class=' item' href="/r/utils/isS3stdGen.html"> <strong>isS3stdGen</strong>: Check if a Function Acts as an S3 Generic </a> <a class=' item' href="/r/utils/LINK.html"> <strong>LINK</strong>: Create Executable Programs on Unix-alikes </a> <a class=' item' href="/r/utils/localeToCharset.html"> <strong>localeToCharset</strong>: Select a Suitable Encoding Name from a Locale Name </a> <a class=' item' href="/r/utils/ls_str.html"> <strong>ls_str</strong>: List Objects and their Structure </a> <a class=' item' href="/r/utils/maintainer.html"> <strong>maintainer</strong>: Show Package Maintainer </a> <a class=' item' href="/r/utils/make.packages.html.html"> <strong>make.packages.html</strong>: Update HTML Package List </a> <a class=' item' href="/r/utils/make.socket.html"> <strong>make.socket</strong>: Create a Socket Connection </a> <a class=' item' href="/r/utils/memory.size.html"> <strong>memory.size</strong>: Report on Memory Allocation (on Windows) </a> <a class=' item' href="/r/utils/menu.html"> <strong>menu</strong>: Menu Interaction Function </a> <a class=' item' href="/r/utils/methods.html"> <strong>methods</strong>: List Methods for S3 Generic Functions or Classes </a> <a class=' item' href="/r/utils/mirrorAdmin.html"> <strong>mirrorAdmin</strong>: Managing Repository Mirrors </a> <a class=' item' href="/r/utils/modifyList.html"> <strong>modifyList</strong>: Recursively Modify Elements of a List </a> <a class=' item' href="/r/utils/news.html"> <strong>news</strong>: Build and Query R or Package News Information </a> <a class=' item' href="/r/utils/nsl.html"> <strong>nsl</strong>: Look up the IP Address by Hostname (on Unix-alikes) </a> <a class=' item' href="/r/utils/object.size.html"> <strong>object.size</strong>: Report the Space Allocated for an Object </a> <a class=' item' href="/r/utils/packageDescription.html"> <strong>packageDescription</strong>: Package Description </a> <a class=' item' href="/r/utils/packageName.html"> <strong>packageName</strong>: Find Package Associated with an Environment </a> <a class=' item' href="/r/utils/package.skeleton.html"> <strong>package.skeleton</strong>: Create a Skeleton for a New Source Package </a> <a class=' item' href="/r/utils/packageStatus.html"> <strong>packageStatus</strong>: Package Management Tools </a> <a class=' item' href="/r/utils/page.html"> <strong>page</strong>: Invoke a Pager on an R Object </a> <a class=' item' href="/r/utils/person.html"> <strong>person</strong>: Persons </a> <a class=' item' href="/r/utils/PkgUtils.html"> <strong>PkgUtils</strong>: Utilities for Building and Checking Add-on Packages </a> <a class=' item' href="/r/utils/process.events.html"> <strong>process.events</strong>: Trigger Event Handling </a> <a class=' item' href="/r/utils/prompt.html"> <strong>prompt</strong>: Produce Prototype of an R Documentation File </a> <a class=' item' href="/r/utils/promptData.html"> <strong>promptData</strong>: Generate Outline Documentation for a Data Set </a> <a class=' item' href="/r/utils/promptPackage.html"> <strong>promptPackage</strong>: Generate a Shell for Documentation of a Package </a> <a class=' item' href="/r/utils/Question.html"> <strong>Question</strong>: Documentation Shortcuts </a> <a class=' item' href="/r/utils/rcompgen.html"> <strong>rcompgen</strong>: A Completion Generator for R </a> <a class=' item' href="/r/utils/Rconsole.html"> <strong>Rconsole</strong>: R for Windows Configuration </a> <a class=' item' href="/r/utils/read.DIF.html"> <strong>read.DIF</strong>: Data Input from Spreadsheet </a> <a class=' item' href="/r/utils/read.fortran.html"> <strong>read.fortran</strong>: Read Fixed-Format Data in a Fortran-like Style </a> <a class=' item' href="/r/utils/read.fwf.html"> <strong>read.fwf</strong>: Read Fixed Width Format Files </a> <a class=' item' href="/r/utils/readRegistry.html"> <strong>readRegistry</strong>: Read a Windows Registry Hive </a> <a class=' item' href="/r/utils/read.socket.html"> <strong>read.socket</strong>: Read from or Write to a Socket </a> <a class=' item' href="/r/utils/read.table.html"> <strong>read.table</strong>: Data Input </a> <a class=' item' href="/r/utils/recover.html"> <strong>recover</strong>: Browsing after an Error </a> <a class=' item' href="/r/utils/relist.html"> <strong>relist</strong>: Allow Re-Listing an unlist()ed Object </a> <a class=' item' href="/r/utils/REMOVE.html"> <strong>REMOVE</strong>: Remove Add-on Packages </a> <a class=' item' href="/r/utils/remove.packages.html"> <strong>remove.packages</strong>: Remove Installed Packages </a> <a class=' item' href="/r/utils/removeSource.html"> <strong>removeSource</strong>: Remove Stored Source from a Function or Language Object </a> <a class=' item' href="/r/utils/RHOME.html"> <strong>RHOME</strong>: R Home Directory </a> <a class=' item' href="/r/utils/roman.html"> <strong>roman</strong>: Roman Numerals </a> <a class=' item' href="/r/utils/Rprof.html"> <strong>Rprof</strong>: Enable Profiling of R's Execution </a> <a class=' item' href="/r/utils/Rprofmem.html"> <strong>Rprofmem</strong>: Enable Profiling of R's Memory Use </a> <a class=' item' href="/r/utils/Rscript.html"> <strong>Rscript</strong>: Scripting Front-End for R </a> <a class=' item' href="/r/utils/RShowDoc.html"> <strong>RShowDoc</strong>: Show R Manuals and Other Documentation </a> <a class=' item' href="/r/utils/RSiteSearch.html"> <strong>RSiteSearch</strong>: Search for Key Words or Phrases in Documentation </a> <a class=' item' href="/r/utils/rtags.html"> <strong>rtags</strong>: An Etags-like Tagging Utility for R </a> <a class=' item' href="/r/utils/Rtangle.html"> <strong>Rtangle</strong>: R Driver for Stangle </a> <a class=' item' href="/r/utils/RweaveLatex.html"> <strong>RweaveLatex</strong>: R/LaTeX Driver for Sweave </a> <a class=' item' href="/r/utils/savehistory.html"> <strong>savehistory</strong>: Load or Save or Display the Commands History </a> <a class=' item' href="/r/utils/select.list.html"> <strong>select.list</strong>: Select Items from a List </a> <a class=' item' href="/r/utils/sessionInfo.html"> <strong>sessionInfo</strong>: Collect Information About the Current R Session </a> <a class=' item' href="/r/utils/setRepositories.html"> <strong>setRepositories</strong>: Select Package Repositories </a> <a class=' item' href="/r/utils/setWindowTitle.html"> <strong>setWindowTitle</strong>: Set the Window Title or the Statusbar of the RGui in Windows </a> <a class=' item' href="/r/utils/SHLIB.html"> <strong>SHLIB</strong>: Build Shared Object/DLL for Dynamic Loading </a> <a class=' item' href="/r/utils/shortPathName.html"> <strong>shortPathName</strong>: Express File Paths in Short Form on Windows </a> <a class=' item' href="/r/utils/sourceutils.html"> <strong>sourceutils</strong>: Source Reference Utilities </a> <a class=' item' href="/r/utils/stack.html"> <strong>stack</strong>: Stack or Unstack Vectors from a Data Frame or List </a> <a class=' item' href="/r/utils/str.html"> <strong>str</strong>: Compactly Display the Structure of an Arbitrary R Object </a> <a class=' item' href="/r/utils/strcapture.html"> <strong>strcapture</strong>: Capture String Tokens into a data.frame </a> <a class=' item' href="/r/utils/summaryRprof.html"> <strong>summaryRprof</strong>: Summarise Output of R Sampling Profiler </a> <a class=' item' href="/r/utils/Sweave.html"> <strong>Sweave</strong>: Automatic Generation of Reports </a> <a class=' item' href="/r/utils/SweaveSyntConv.html"> <strong>SweaveSyntConv</strong>: Convert Sweave Syntax </a> <a class=' item' href="/r/utils/SweaveUtils.html"> <strong>SweaveUtils</strong>: Sweave Driver Utilities </a> <a class=' item' href="/r/utils/tar.html"> <strong>tar</strong>: Create a Tar Archive </a> <a class=' item' href="/r/utils/toLatex.html"> <strong>toLatex</strong>: Converting R Objects to BibTeX or LaTeX </a> <a class=' item' href="/r/utils/txtProgressBar.html"> <strong>txtProgressBar</strong>: Text Progress Bar </a> <a class=' item' href="/r/utils/type.convert.html"> <strong>type.convert</strong>: Convert Data to Appropriate Type </a> <a class=' item' href="/r/utils/untar.html"> <strong>untar</strong>: Extract or List Tar Archives </a> <a class=' item' href="/r/utils/unzip.html"> <strong>unzip</strong>: Extract or List Zip Archives </a> <a class=' item' href="/r/utils/update.packages.html"> <strong>update.packages</strong>: Compare Installed Packages with CRAN-like Repositories </a> <a class=' item' href="/r/utils/URLencode.html"> <strong>URLencode</strong>: Encode or Decode (partial) URLs </a> <a class=' item' href="/r/utils/url.show.html"> <strong>url.show</strong>: Display a Text URL </a> <a class=' item' href="/r/utils/utils-defunct.html"> <strong>utils-defunct</strong>: Defunct Functions in Package 'utils' </a> <a class=' item' href="/r/utils/utils-deprecated.html"> <strong>utils-deprecated</strong>: Deprecated Functions in Package 'utils' </a> <a class=' item' href="/r/utils/utils-package.html"> <strong>utils-package</strong>: The R Utils Package </a> <a class=' item' href="/r/utils/View.html"> <strong>View</strong>: Invoke a Data Viewer </a> <a class=' item' href="/r/utils/vignette.html"> <strong>vignette</strong>: View, List or Get R Source of Package Vignettes </a> <a class=' item' href="/r/utils/warnErrList.html"> <strong>warnErrList</strong>: Collect and Summarize Errors From List </a> <a class=' item' href="/r/utils/winDialog.html"> <strong>winDialog</strong>: Dialog Boxes under Windows </a> <a class=' item' href="/r/utils/winextras.html"> <strong>winextras</strong>: Get Windows Version </a> <a class=' item' href="/r/utils/winMenus.html"> <strong>winMenus</strong>: User Menus under MS Windows (Rgui) </a> <a class=' item' href="/r/utils/winProgressBar.html"> <strong>winProgressBar</strong>: Progress Bars under MS Windows </a> <a class=' item' href="/r/utils/write.table.html"> <strong>write.table</strong>: Data Output </a> <a class=' item' href="/r/utils/zip.html"> <strong>zip</strong>: Create Zip Archives </a> </div> </div> </div> <!-- suggestions button --> <div style='position: fixed; bottom: 2%; right: 2%; z-index: 1000;'> <div class="ui raised segment surveyPopup" style='display:none'> <div class="ui large header">What can we improve?</div> <div class='content'> <div class="ui form"> <div class="field"> <button class='ui fluid button surveyReasonButton'>The page or its content looks wrong</button> </div> <div class="field"> <button class='ui fluid button surveyReasonButton'>I can't find what I'm looking for</button> </div> <div class="field"> <button class='ui fluid button surveyReasonButton'>I have a suggestion</button> </div> <div class="field"> <button class='ui fluid button surveyReasonButton'>Other</button> </div> <div class="field"> <label>Extra info (optional)</label> <textarea class='surveyText' rows='3' placeholder="Please enter more detail, if you like. Leave your email address if you'd like us to get in contact with you."></textarea> </div> <div class='ui error message surveyError' style='display: none'></div> <button class='ui large fluid green disabled button surveySubmitButton'>Submit</button> </div> </div> </div> <button class='ui blue labeled icon button surveyButton only-desktop' style='display: none; float: right;'><i class="comment icon"></i> Improve this page</button> </div> <script async src="//pagead2.googlesyndication.com/pagead/js/adsbygoogle.js"></script> <div class="ui inverted darkblue vertical footer segment" style='margin-top: 16px; padding: 32px;'> <div class="ui center aligned container"> <div class="ui stackable inverted divided three column centered grid"> <div class="five wide column"> <h4 class="ui inverted header">R Package Documentation</h4> <div class='ui inverted link list'> <a class='item' href='/' >rdrr.io home</a> <a class='item' href='/r/'>R language documentation</a> <a class='item' href='/snippets/'>Run R code online</a> </div> </div> <div class="five wide column"> <h4 class="ui inverted header">Browse R Packages</h4> <div class='ui inverted link list'> <a class='item' href='/all/cran/'>CRAN packages</a> <a class='item' href='/all/bioc/'>Bioconductor packages</a> <a class='item' href='/all/rforge/'>R-Forge packages</a> <a class='item' href='/all/github/'>GitHub packages</a> </div> </div> <div class="five wide column"> <h4 class="ui inverted header">We want your feedback!</h4> <small>Note that we can't provide technical support on individual packages. You should contact the package authors for that.</small> <div class='ui inverted link list'> <a class='item' href="https://twitter.com/intent/tweet?screen_name=rdrrHQ"> <div class='ui large icon label twitter-button-colour'> <i class='whiteish twitter icon'></i> Tweet to @rdrrHQ </div> </a> <a class='item' href="https://github.com/rdrr-io/rdrr-issues/issues"> <div class='ui large icon label github-button-colour'> <i class='whiteish github icon'></i> GitHub issue tracker </div> </a> <a class='item' href="mailto:ian@mutexlabs.com"> <div class='ui teal large icon label'> <i class='whiteish mail outline icon'></i> ian@mutexlabs.com </div> </a> <a class='item' href="https://ianhowson.com"> <div class='ui inverted large image label'> <img class='ui avatar image' src='/static/images/ianhowson32.png'> <span class='whiteish'>Personal blog</span> </div> </a> </div> </div> </div> </div> <br /> <div class='only-mobile' style='min-height: 120px'> </div> </div> <div class="ui modal snippetsModal"> <div class="header"> Embedding an R snippet on your website </div> <div class="content"> <div class="description"> <p>Add the following code to your website.</p> <p> <textarea class='codearea snippetEmbedCode' rows='5' style="font-family: Consolas,Monaco,'Andale Mono',monospace;">REMOVE THIS</textarea> <button class='ui blue button copyButton' data-clipboard-target='.snippetEmbedCode'>Copy to clipboard</button> </p> <p>For more information on customizing the embed code, read <a href='/snippets/embedding/'>Embedding Snippets</a>.</p> </div> </div> <div class="actions"> <div class="ui button">Close</div> </div> </div> <script type="text/javascript" src="/static/CACHE/js/73d0b6f91493.js"></script> <script type="text/javascript" src="/static/CACHE/js/484b2a9a799d.js"></script> <script type="text/javascript" src="/static/CACHE/js/4f8010c72628.js"></script> <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Open+Sans:400,400italic,600,600italic,800,800italic"> <link rel="stylesheet" href="//fonts.googleapis.com/css?family=Oswald:400,300,700"> </body> </html>