Merge pull request #105 from metrumresearchgroup/file-delete

Add fileDelete function

NAMESPACE

@@ -14,6 +14,7 @@ export(logAccept)
 export(logAssign)
 export(logCreate)
 export(logPending)
+export(logRemove)
 export(logSummary)
 export(renderQCSummary)
 export(repoHistory)

NEWS.md

@@ -2,6 +2,8 @@
 
 ## New features and changes
 
+- `logRemove` added to package to assist with removing files from the QC log. (#105)
+
 - `diffFiles` can now display the entire file that is being diffed. (#115)
 
 - Added `repoHistory` function to return history of all commits in the repository. (#116)

R/logRemove.R

@@ -0,0 +1,24 @@
+#' Remove file from QClog
+#' 
+#' @description 
+#' This function facilitates deleting a file from the QClog.csv file. 
+#' When run, all rows associated with the file will be deleted and 
+#' removed from the QC log.
+#' 
+#' @param .filepath current file path of file to be removed
+#' 
+#' @export
+logRemove <- function(.filepath) {
+
+  qclog <- logRead()
+  qclog2 <- qclog[qclog$file != .filepath, ]
+
+  # Check current file path exists
+  if(nrow(qclog) == nrow(qclog2)) {
+    stop(paste0(.filepath, " does not exist in QClog.csv"))
+  }
+
+  cli::cli_alert_info(glue::glue("Deleted '{.filepath}' from QClog.csv"))
+
+  logWrite(qclog2, file = "QClog.csv")
+}

_pkgdown.yml

@@ -37,4 +37,5 @@ reference:
     - svnLog
     - svnExport
     - demoRepo
+    - logRemove
     - repoHistory

tests/testthat/test-logRemove.R

@@ -0,0 +1,16 @@
+with_demoRepo({
+
+  testthat::test_that("logRemove removes the file from the QClog", {
+
+    qclog <- logRead()
+    expect_true(nrow(qclog[qclog$file == "script/data-assembly.R",]) > 0)
+
+    logRemove("script/data-assembly.R")
+    qclog2 <- logRead()
+
+    expect_true(nrow(qclog2[qclog2$file == "script/data-assembly.R",]) == 0)
+  }) 
+})
+
+
+