Changes to tidy up imports, comments and other (from PR #41) (#42)

* Updating version number Also included the min dplyr version that supports `mutate_all` * Update README.md * Rob tidy (#41) * Updated documentation files. Removed some nonsense from the vignette header. Added import for mutate_all * Removes mutate_each as a requirement * Added news.md
capitalone · Nov 10, 2017 · 60815f0 · 60815f0
1 parent 7303314
commit 60815f0
Show file tree

Hide file tree

Showing 13 changed files with 26 additions and 25 deletions.
diff --git a/README.md b/README.md
@@ -7,7 +7,7 @@
 
 dataCompareR is an R package that allows users to compare two datasets and view a report on the similarities and differences. 
 
-dataCompareR aims to make it easy to compare two tabular data objects in R. It’s specifically designed to show differences between two sets of data in a useful way that should make it easier to understand the differences, and if necessary, help you work out how to remedy them. In this regard, it aims to offer a more useful output than *all.equal* when your two datasets do not match, but isn’t intended to replace *all.equal* if you just want to test for equality.
+dataCompareR aims to make it easy to compare two tabular data objects in R. It’s specifically designed to show differences between two sets of data in a useful way that should make it easier to understand the differences, and if necessary, help you work out how to remedy them. In this regard, it aims to offer a more useful output than *all.equal* when your two datasets do not match, but isn’t intended to replace *all.equal* if you just want a binary test for equality.
 
 ## Getting started
 
@@ -87,9 +87,9 @@ Automated tests that are run via
 
 ``devtools::test()``
 
-This consists of both unit tests and some end-to-end tests that **MUST** pass before any code is merged to dev or main. There is no exception to this - if your code change breaks an existing test, then it is your responsibility to fix it! 
+This consists of both unit tests and some end-to-end tests that **MUST** pass before any code is merged to dev or main. We've added Travis integration, so this is now mandated. If your development code change breaks an existing test, then it is your responsibility to fix it! 
 
-The current unit test coverage can be founbd in `testing.md` -  please feel free to add more tests!
+The current unit test coverage can be found in `testing.md` -  please feel free to add more tests, and regenerate this file using `covR`.
 
 #### dataCompareR/tests/performancetesting
 

diff --git a/dataCompareR/DESCRIPTION b/dataCompareR/DESCRIPTION
@@ -1,6 +1,6 @@
 Package: dataCompareR
 Title: Compare Two Data Frames and Summarise the Difference
-Version: 0.1.0
+Version: 0.1.1
 Authors@R: c(person("Rob", "Noble-Eddy", email = "[email protected]", role = c("aut", "cre")),
            person("Sarah", "Johnston", role = c("aut")),
            person("Sarah", "Pollicott", role = c("aut")),
@@ -30,7 +30,7 @@ Description:  Easy comparison of two tabular data
 Depends:
     R (>= 3.2.3)
 Imports:
-    dplyr,
+    dplyr (>= 0.5.0),
     knitr,
     stringi,
     markdown

diff --git a/dataCompareR/R/cd_locateMismatches.R b/dataCompareR/R/cd_locateMismatches.R
@@ -47,6 +47,9 @@ mismatchHighStop <- function(trueFalseMatrix, maxMismatches) {
 #' @param maxMismatches Integer. The max number of mismatches to assess, after which dataCompareR will stop 
 #' (without producing a dataCompareR object). Designed to improve performance for large datasets.
 #' @param keys character vector of index variables
+#' 
+#' @importFrom dplyr mutate_all
+#' 
 #' @return data frame containing keys and boolean logic of match/no match for each element
 #'         If data types are not equal returns FALSE. Treats NA and NaN as unequal.
 locateMismatches <- function(DFA, DFB, keys=NULL, maxMismatches=NA){

diff --git a/dataCompareR/R/rc_rCompare.R b/dataCompareR/R/rc_rCompare.R
@@ -36,7 +36,6 @@
 #' @importFrom dplyr arrange
 #' @importFrom dplyr arrange_
 #' @importFrom dplyr funs
-#' @importFrom dplyr mutate_each
 #' @importFrom dplyr sample_n
 #' @importFrom dplyr inner_join
 #' @importFrom dplyr distinct

diff --git a/dataCompareR/man/compareData.Rd b/dataCompareR/man/compareData.Rd
diff --git a/dataCompareR/man/locateMismatches.Rd b/dataCompareR/man/locateMismatches.Rd
diff --git a/dataCompareR/man/print.dataCompareRobject.Rd b/dataCompareR/man/print.dataCompareRobject.Rd
diff --git a/dataCompareR/man/processFlow.Rd b/dataCompareR/man/processFlow.Rd
diff --git a/dataCompareR/man/rCompare.Rd b/dataCompareR/man/rCompare.Rd
diff --git a/dataCompareR/man/saveReport.Rd b/dataCompareR/man/saveReport.Rd
diff --git a/dataCompareR/man/validateArguments.Rd b/dataCompareR/man/validateArguments.Rd
diff --git a/dataCompareR/vignettes/dataCompareR.Rmd b/dataCompareR/vignettes/dataCompareR.Rmd
@@ -11,14 +11,6 @@
 # Unless required by applicable law or agreed to in writing, software distributed 
 # under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS
 # OF ANY KIND, either express or implied.
-
-#
-# UNIT TEST: print.summary.dataCompareRobject
-#
-# * Assumes that the output of dataCompareR is accurate
-#
-# The print output of the summary object of the dataCompareR object 
-# should have a certain structure depending on the content of the object.
 -->
 
 ---

diff --git a/news.md b/news.md
@@ -0,0 +1,7 @@
+# dataComparepR 0.1.0
+
+Intial release
+
+# dataComparepR 0.1.1
+
+Mainly fixes compatibility with new versions of dplyr by using `mutate_all` rather than `mutate_each`. Also fixes some other minor bugs and typos in documentation.