1。创建一个新包

Question

我写了一个函数，可以帮助逐步执行管道链。

要使用它，用户必须将指令复制到剪贴板，然后执行功能，并移至控制台以继续。

我想构建一个插件，使我可以选择指令并使用Ctrl + P运行该函数，而无需执行笨拙的步骤。

理想情况下，插件将：

捕获选择
运行功能
将光标移至控制台
由 Ctrl + P

我相信它与reprex插件的功能极为相似，但我不知道从哪里开始，因为我是100％刚接触插件的人。

我看着rstudioapi::getActiveDocumentContext()，但我没有兴趣。

我该如何进行这项工作？

功能

debug_pipe <- function(.expr){
  .pchain <-
    if (missing(.expr)) readClipboard() # windows only , else try clipr::read_clip()
  else deparse(substitute(.expr))

  .lhs    <- if (grepl("^\\s*[[:alnum:]_.]*\\s*<-",.pchain[1])) {
    sub("^\\s*([[:alnum:]_.]*)\\s*<-.*","\\1",.pchain[1]) 
  } else NA

  .pchain <- sub("[^%]*<-\\s*","",.pchain)        # remove lhs of assignment if exists
  .pchain <- paste(.pchain,collapse = " ")          # collapse 
  .pchain <- gsub("\\s+"," ",.pchain)             # multiple spaces to single 
  .pchain <- strsplit(.pchain,"\\s*%>%\\s*")[[1]] # split by pipe
  .pchain <- as.list(.pchain)

  for (i in rev(seq_along(.pchain))) {
    # function to count matches
    .f <- function(x) sum(gregexpr(x,.pchain[i],fixed = TRUE)[[1]] != -1)
    # check if unbalanced operators
    .balanced <-
      all(c(.f("{"),.f("("),.f("[")) == c(.f("}"),.f(")"),.f("]"))) &
      !.f("'") %% 2 &
      !.f('"') %% 2

    if (!.balanced) {
      # if unbalanced, combine with previous
      .pchain[[i - 1]] <- paste(.pchain[[i - 1]],"%>%", .pchain[[i]])
      .pchain[[i]] <- NULL
    }
  }

  .calls  <- Reduce(                             # build calls to display
    function(x,y) paste0(x," %>%\n  ",y),       
    .pchain, accumulate = TRUE)     

  .xinit  <- eval(parse(text = .pchain[1]))      
  .values <- Reduce(function(x,y){               # compute all values
    if (inherits(x,"try-error")) NULL
    else try(eval(parse(text = paste("x %>%", y))),silent = TRUE)},
    .pchain[-1], .xinit, accumulate = TRUE)

  message("press enter to show, 's' to skip, 'q' to quit, lhs can be accessed with `.`")
  for (.i in (seq_along(.pchain))) {
    cat("\n",.calls[.i])
    .rdl_ <- readline()
    . <- .values[[.i]]

    # while environment is explored
    while (!.rdl_ %in% c("q","s","")) {
      # if not an assignment, should be printed
      if (!grepl("^\\s*[[:alnum:]_.]*\\s*<-",.rdl_)) .rdl_ <- paste0("print(",.rdl_,")")
      # wrap into `try` to safely fail
      try(eval(parse(text = .rdl_)))
      .rdl_ <- readline()
    }
    if (.rdl_ == "q")  return(invisible(NULL))
    if (.rdl_ != "s") {
      if (inherits(.values[[.i]],"try-error")) {
        # a trick to be able to use stop without showing that
        # debug_pipe failed in the output
        opt <- options(show.error.messages = FALSE)
        on.exit(options(opt))
        message(.values[[.i]])
        stop()
      } else
      {
        print(.)
      }
    }
  }
  if (!is.na(.lhs)) assign(.lhs,tail(.values,1),envir = parent.frame())
  invisible(NULL)
}

示例代码：

library(dplyr)

# copy following 4 lines to clipboard, no need to execute
test <- iris %>%
  slice(1:2) %>%
  select(1:3) %>%
  mutate(x=3)

debug_pipe()

# or wrap expression
debug_pipe(
test <- iris %>%
  slice(1:2) %>%
  select(1:3) %>%
  mutate(x=3)
)

Answer 1

这是我随附的步骤：

两个好的资源是：

1。创建一个新包

新的Project / R包/名称包为pipedebug

2。建立R档案

将函数的代码放入.R文件夹中的R文件中。我们重命名了函数pdbg，因为我意识到magrittr已经具有一个名为debug_pipe的函数，该函数的功能有所不同（它执行浏览器并返回输入）。

我们必须添加第二个函数，不带参数，该插件会触发，我们可以根据需要命名它：

pdbg_addin <- function(){
  selection <- rstudioapi::primary_selection(
    rstudioapi::getSourceEditorContext())[["text"]]
  rstudioapi::sendToConsole("",execute = F)
  eval(parse(text=paste0("pdbg(",selection,")")))
}

第一行根据reprex的代码捕获选择。

第二行是向控制台发送一个空字符串而不执行它，这是我发现的所有移动光标的方法，但是也许有更好的方法。

第三行以所选内容作为参数运行main函数。我之所以使用eval(parse(text(是因为我不知道该怎么做，但我认为它是邪恶的。

3。创建dcf文件

下一步是创建具有以下内容的文件inst/rstudio/addins.df：

Name: debug pipe
Description: debug pipes step by step
Binding: pdbg_addin
Interactive: false

4。构建软件包

Ctrl + Shift + B

5。添加快捷方式

工具/插件/浏览插件/键盘快捷键/调试管道/ Ctrl + P

6。测试

在文本编辑器中复制/选择/ Ctrl + P

test <- iris %>%
  slice(1:2) %>%
  select(1:3) %>%
  mutate(x=3)

找到一个粗略的版本here：

devtools::install_github("moodymudskipper/pipedebug")
?pdbg

类似的努力：

@Alistaire did this并在其页面上投放广告this other effort。

构建一个RStudio插件来调试管道链

1 个答案:

1。创建一个新包

2。建立R档案

3。创建dcf文件

4。构建软件包

5。添加快捷方式

6。测试