improve docs

R/addins.R

@@ -1,48 +1,41 @@
 #' RStudio Addin: Containerize R Markdown Document
 #'
-#' Call this function as an addin to dockerize (lift) the current document.
+#' RStudio addin for containerizing the current document.
 #'
 #' @importFrom rstudioapi getActiveDocumentContext
 #'
 #' @keywords internal
 addin_lift = function() {
-
   context = rstudioapi::getActiveDocumentContext()
   path = normalizePath(context$'path')
   lift(path)
-
 }
 
 #' RStudio Addin: Containerize and Render R Markdown Document with Docker
 #'
-#' Call this function as an addin to containerize and render
-#' the current document.
+#' RStudio addin for containerizing and rendering the current document.
 #'
 #' @importFrom rstudioapi getActiveDocumentContext
 #'
 #' @keywords internal
 addin_lift_render_docker = function() {
-
   context = rstudioapi::getActiveDocumentContext()
   path = normalizePath(context$'path')
   lift(path)
   render_docker(path)
-
 }
 
 #' RStudio Addin: Purge Docker Image
 #'
-#' Call this function as an addin to removes the Docker image used
-#' for rendering the current document.
+#' RStudio addin for removing the Docker image used for
+#' rendering the current document.
 #'
 #' @importFrom rstudioapi getActiveDocumentContext
 #'
 #' @keywords internal
 addin_purge_image = function() {
-
   context = rstudioapi::getActiveDocumentContext()
   path = normalizePath(context$'path')
   path = paste0(file_dir(path), '/', file_name_sans(path), '.docker.yml')
   purge_image(path)
-
 }

R/liftr-package.R

@@ -8,8 +8,9 @@
 #'
 #' @name liftr-package
 #' @docType package
-#' @author Nan Xiao <\email{me@@nanx.me}>
-#'         Miaozhu Li <\email{miaozhu.li@@duke.edu}>
-#'         Tengfei Yin <\email{tengfei.yin@@sevenbridges.com}>
+#' @author
+#' Nan Xiao <\email{me@@nanx.me}>
+#' Miaozhu Li <\email{miaozhu.li@@duke.edu}>
+#' Tengfei Yin <\email{tengfei.yin@@sevenbridges.com}>
 #'
 NULL