lingt

NEWS.md

@@ -1,4 +1,4 @@
-# compareDF 2.0.0
+## compareDF 2.0.0
 * New Major Version! Contains some breaking changes
 * Support for `XLSX` format
 * Write output to file directly
@@ -7,58 +7,55 @@
 * More bugs squashed
 * Color blind friendly default colors
 
-# compareDF 1.8.0
+## compareDF 1.8.0
 * Added new option to keep only the columns which have changed using `keep_unchanged_cols`. 
 * changed option `keep_unchanged` to `keep_unchanged_rows`
 
-# compareDF 1.7.3
+## compareDF 1.7.3
 * Fixed tests to work with dplyr 0.8.2 and on Linux systems
 
-# compareDF 1.7.2
+## compareDF 1.7.2
 * Fixed tests to work with dplyr 0.8.1
 
-# compareDF 1.7.1
+## compareDF 1.7.1
 * Fixed tests to work with dplyr 0.8.0
 
-# compareDF 1.7.0
+## compareDF 1.7.0
 * Provided options to name the columns in the HTML output
 * Provided option change column name
 * Provided option to change group column name
 
-# compareDF 1.6.0
+## compareDF 1.6.0
 * Added option to specify different types of tolerances. Now you can use `difference` as an argument to use difference rather than ratio
 * Fixed some bugs
 * Lot more tests
 
-# compareDF 1.5.0
+## compareDF 1.5.0
 * Added an option to preserve the rows that have not changed in the analysis using the `keep_unchanged_rows` argument
 * Added an option to set the color scheme in the HTML using the `color_scheme` argument.
 * Updated Documentation
 * Fixed some bugs
 * Fixed dependencies
 
-# compareDF 1.3.1
+## compareDF 1.3.1
 * added a test dependency(stringr) as notified by CRAN
 
-# compareDF 1.3.0
+## compareDF 1.3.0
 * added an option to ignore errors `stop_on_error`
 
-# compareDF 1.2.0
+## compareDF 1.2.0
 * Fixed bugs
 * view_html function to view the html file created for setups that cannot print html directly
 
-# compareDF 1.1.2
+## compareDF 1.1.2
 * compareDF can now handle negative inputs correctly
 
-# compareDF 1.1.1
+## compareDF 1.1.1
 * Fixed some bugs when the two frames are similar except reordering
 
-# compareDF 1.1.0
+## compareDF 1.1.0
 * Fixed some bugs
 
-# compareDF 1.0.0
+## compareDF 1.0.0
 
 * First Release!
-
-
-

README.md

@@ -149,15 +149,14 @@ groups and compared accordingly. All the other summaries also change appropriate
 
 ### Excluding certain Columns
 
-You can ignore certain columns using the *exclude* parameter. The fields that have to be
+You can ignore certain columns using the _exclude_ parameter. The fields that have to be
 excluded can be given as a character vector. (This is a convenience function to deal with 
 the case where some columns are not included)
 
 ### Preserving all rows
 
 The default behavior of the `compare_df` function is to show only the records that have changed. Sometimes the use might want to preserve all the records even after the comparison and not just see the values that have been changed (especially in the HTML). In this case, you can set the `keep_unchanged` parameter to `TRUE`. 
 
-
 ### Limiting HTML size
 
 For dataframes which have a large amount of differences in them, generating HTML might take 
@@ -170,7 +169,6 @@ checking. The main comparison data frame and the summaries ALWAYS include data f
 
 You can use the `color_scheme` parameter to change the color of the cells generated. The parameter must me a named vector or a list with the appropriate names - The default values are `c("addition" = "green", "removal" = "red", "unchanged_cell" = "gray", "unchanged_row" = "deepskyblue")` but can be changed as needed by the user.
 
-
 ### Tolerance
 
 It is possible that you'd like numbers very close to each other to be ignored. For example,
@@ -191,13 +189,13 @@ diff calculation or in the output
 Naturally, tolerance has no meaning for non-numeric values.
 
 ## Additional features
-*  set the color scheme in the HTML using the `color_scheme` argument
-*  preserve the rows that have not changed in the analysis using the `keep_unchanged_rows` argument
-*  use `difference` as an argument to use difference rather than ratio for tolerance
-*  options to name the columns in the HTML output
-*  option change column name
-*  option to change group column name
-*  keep only the columns which have changed using `keep_unchanged_cols`
+* set the color scheme in the HTML using the `color_scheme` argument
+* preserve the rows that have not changed in the analysis using the `keep_unchanged_rows` argument
+* use `difference` as an argument to use difference rather than ratio for tolerance
+* options to name the columns in the HTML output
+* option change column name
+* option to change group column name
+* keep only the columns which have changed using `keep_unchanged_cols`
 
 ## Using compare DF in GAP analysis
 
@@ -208,8 +206,8 @@ The compareDF package can be used to conduct effective Gap analyses. If the pack
 Thanks to Nitin for proofreading the doc and making sure everything made sense.
 
 ## Contributors
-*  Brice Richard
-*  Joshua David Barillas - https://github.com/jdbarillas
+* Brice Richard
+* Joshua David Barillas - <https://github.com/jdbarillas>
 
 License (MIT)