Some documentation and cleanup

gwd666 · Aug 21, 2018 · 3b88b7e · 3b88b7e
1 parent da4c693
commit 3b88b7e
Show file tree

Hide file tree

Showing 5 changed files with 24 additions and 7 deletions.
diff --git a/DESCRIPTION b/DESCRIPTION
@@ -2,14 +2,13 @@ Package: ViewPipeSteps
 Type: Package
 Title: Create View Tabs of Pipe Chains 
 Version: 0.1.0
-Author: David Ranzolin
+Author: David Ranzolin [aut, cre], 
+  Joachim Gassen [aut]
 Maintainer: David Ranzolin <[email protected]>
 Description: Debugging pipe chains often consists of viewing the output after each step. 
   This addin automatically creates a View() output of each step.
 License: MIT + file LICENSE
 Encoding: UTF-8
 LazyData: true
-Imports: stringr (>= 1.3.0),
-    purrr,
-    magrittr
+Imports: rstudioapi
 RoxygenNote: 6.0.1
diff --git a/NAMESPACE b/NAMESPACE
@@ -1,2 +1 @@
-exportPattern("^[[:alpha:]]+")
-importFrom(magrittr,"%>%")
+export("viewPipeChain")
diff --git a/R/viewPipeChain.R b/R/viewPipeChain.R
@@ -29,7 +29,14 @@ findPipeCalls <- function(x) {
   rev(pl)
 }
 
-
+#' @title Creates a View() output for each pipe step in current text selection
+#'
+#' @description
+#'   Reads the currently selected text from the RStudio API and displays a data view
+#'   in the source pane for each pipe step. Meant to be called as a RStudio addin.
+#'
+#' @export
+#'
 viewPipeChain <- function() {
   context <- rstudioapi::getActiveDocumentContext()
   selection <- context$selection[[1]]$text

diff --git a/man/viewPipeChain.Rd b/man/viewPipeChain.Rd
diff --git a/test_cases.R → tools/test_cases.R b/test_cases.R → tools/test_cases.R