Read and Write from the System Clipboard
Simple utility functions to read from and write to the Windows,
OS X, and X11 clipboards.
Simple utility functions to read and write from the system clipboards of Windows, OS X, and Unix-like systems (which require either xclip or xsel.)
Install from CRAN
Or try the development version
library("clipr") cb <- read_clip() # Character vectors with length > 1 will be collapsed with system-appropriate # line breaks, unless otherwise specified cb <- write_clip(c("Text", "for", "clipboard")) cb #>  "Text\nfor\nclipboard" cb <- write_clip(c("Text", "for", "clipboard"), breaks = ", ") cb #>  "Text, for, clipboard"
write_clip also tries to intelligently handle data.frames and
matrices, rendering them with
write.table so that they can be pasted
into a spreadsheet like Excel.
tbl <- data.frame(a = c(1, 2, 3), b = c(4, 5, 6)) cb <- write_clip(tbl) cb #>  "a\tb\n1\t4\n2\t5\n3\t6"
read_clip_tbl will try to parse clipboard contents from spreadsheets
into data frames directly.
Developing with clipr
Interactive & non-interactive use
If you use clipr in your own package, you should not call it in non-interactive sessions, as this goes against CRAN repository policy:
Packages should not write in the user’s home filespace (including clipboards), nor anywhere else on the file system apart from the R session’s temporary directory (or during installation in the location pointed to by TMPDIR: and such usage should be cleaned up). Installing into the system’s R installation (e.g., scripts to its bin directory) is not allowed.
Limited exceptions may be allowed in interactive sessions if the package obtains confirmation from the user.
Linux utility availability
clipr’s functionality on X11-based systems depends on the installation
of additional software. Therefore, if you want to use clipr in your
package, you will want to take some care in how you call it, and make
sure that your package will respond gracefully if clipboard
functionality is not working as expected. You can use the function
clipr_available() to check if the clipboard is readable and writable
by the current R session.
Testing on CRAN and CI
A few best practices will also help you responsibly test your clipr-using package on headless systems like CRAN or other testing infrastructure like Travis:
- Examples that will try to use
write_clip()ought to be wrapped in
- Tests calling clipr should be conditionally skipped, based on the
clipr_available(). This is necessary to pass CRAN checks.
- If you are using Travis.ci to check your
package build on Linux, consult the
.travis.ymlfor this package, which includes code for setting the
DISPLAYenvironment variable, installing
xsel, and running a pre-build script that will set up
xselto run headlessly.
- If you wish to display system requirements and configuration
messages to X11 users,
Nice uses of clipr
(a non-comprehensive list)
- reprex by @jennybc takes R code on the clipboard and renders a reproducible example from it, ready to then paste on to GitHub, Stack Overflow, or the like.
- datapasta by @milesmcbain eases the copying and pasting of R objects in and out of different sources (Excel, Google Sheets).
- curlconverter by @hrbrmstr translates cURL command lines into httr calls.
Functions in clipr
|clipr_available||Is the system clipboard available?|
|clipr||clipr: Read and Write from the System Clipboard|
|read_clip_tbl||Transforms output of read_clip into data frame.|
Last month downloads
|SystemRequirements||xclip (https://github.com/astrand/xclip) or xsel (http://www.vergenet.net/~conrad/software/xsel/) for accessing the X11 clipboard|
|Packaged||2018-06-23 19:32:09 UTC; admin|
|Date/Publication||2018-06-23 19:47:55 UTC|
Include our badge in your README