From b58342107410a6b940caf147951e3668b8fc5276 Mon Sep 17 00:00:00 2001 From: Matthew Lincoln Date: Wed, 7 Oct 2020 16:44:05 -0400 Subject: [PATCH] regen docs with latest roxygen --- DESCRIPTION | 2 +- man/clipr.Rd | 1 - man/read_clip.Rd | 3 +-- man/read_clip_tbl.Rd | 2 +- man/write_clip.Rd | 14 ++++++++++---- 5 files changed, 13 insertions(+), 9 deletions(-) diff --git a/DESCRIPTION b/DESCRIPTION index 48ca996..f6f1cea 100644 --- a/DESCRIPTION +++ b/DESCRIPTION @@ -36,7 +36,7 @@ Encoding: UTF-8 Language: en-US LazyData: TRUE Roxygen: list(markdown = TRUE) -RoxygenNote: 6.1.1 +RoxygenNote: 7.1.1 SystemRequirements: xclip (https://github.com/astrand/xclip) or xsel (http://www.vergenet.net/~conrad/software/xsel/) for accessing the X11 clipboard diff --git a/man/clipr.Rd b/man/clipr.Rd index 69a1dc3..f40b8ee 100644 --- a/man/clipr.Rd +++ b/man/clipr.Rd @@ -3,7 +3,6 @@ \docType{package} \name{clipr} \alias{clipr} -\alias{clipr-package} \title{clipr: Read and Write from the System Clipboard} \description{ Simple utility functions to read from and write to the Windows, OS X, and X11 diff --git a/man/read_clip.Rd b/man/read_clip.Rd index e3fd8ba..41a91dd 100644 --- a/man/read_clip.Rd +++ b/man/read_clip.Rd @@ -4,8 +4,7 @@ \alias{read_clip} \title{Read clipboard} \usage{ -read_clip(allow_non_interactive = Sys.getenv("CLIPR_ALLOW", - interactive())) +read_clip(allow_non_interactive = Sys.getenv("CLIPR_ALLOW", interactive())) } \arguments{ \item{allow_non_interactive}{By default, clipr will throw an error if run in diff --git a/man/read_clip_tbl.Rd b/man/read_clip_tbl.Rd index 8427723..74bbb3b 100644 --- a/man/read_clip_tbl.Rd +++ b/man/read_clip_tbl.Rd @@ -14,7 +14,7 @@ character vector already generated by \code{\link[=read_clip]{read_clip()}}.} \code{\link[=read.table]{read.table()}} arguments will be passed by default, but can be overridden by specifying them when calling \code{read_clip_tbl}: \describe{ \item{\code{header}}{\code{TRUE}} -\item{\code{sep}}{\code{"\t"}} +\item{\code{sep}}{\code{"\\t"}} \item{\code{row.names}}{\code{1}} \item{\code{stringsAsFactors}}{\code{FALSE}} \item{\code{na.strings}}{\code{c("NA", "")}} diff --git a/man/write_clip.Rd b/man/write_clip.Rd index e818636..95fc567 100644 --- a/man/write_clip.Rd +++ b/man/write_clip.Rd @@ -4,9 +4,15 @@ \alias{write_clip} \title{Write clipboard} \usage{ -write_clip(content, object_type = c("auto", "character", "table"), - breaks = NULL, eos = NULL, return_new = FALSE, - allow_non_interactive = Sys.getenv("CLIPR_ALLOW", interactive()), ...) +write_clip( + content, + object_type = c("auto", "character", "table"), + breaks = NULL, + eos = NULL, + return_new = FALSE, + allow_non_interactive = Sys.getenv("CLIPR_ALLOW", interactive()), + ... +) } \arguments{ \item{content}{An object to be written to the system clipboard.} @@ -37,7 +43,7 @@ a non-interactive session. Set the environment variable table-like). Defaults to sane line-break and tab standards based on the operating system. By default, this will use \code{col.names = TRUE} if the table object has column names, and \code{row.names = TRUE} if the object has row names -other than \code{c("1", "2", "3"...)}. Override these defaults by passing +other than \verb{c("1", "2", "3"...)}. Override these defaults by passing arguments here.} } \value{