Update documenation for expss.options. #100

DESCRIPTION

@@ -1,7 +1,7 @@
 Package: expss
 Type: Package
 Title: Tables, Labels and Some Useful Functions from Spreadsheets and 'SPSS' Statistics
-Version: 0.11.4
+Version: 0.11.5
 Maintainer: Gregory Demin <gdemin@gmail.com>
 Authors@R: c(
          person("Gregory", "Demin", email = "gdemin@gmail.com",
@@ -52,4 +52,4 @@ Description: Package computes and displays tables with support for 'SPSS'-style
 VignetteBuilder: knitr
 LazyData: yes
 License: GPL (>= 2)
-RoxygenNote: 7.2.1
+RoxygenNote: 7.2.3

R/expss_options.R

@@ -10,12 +10,12 @@
 #' methods. \code{NULL} is default and means one digit. \code{NA} means no
 #' rounding. There is a convenience function for this option:
 #' \code{expss_digits}.}
-#' \item{\code{expss.round_half_to_even} }{ Determine which rounding we will use.
-#'  Default rounding is standard R rounding: "half to even". For rounding "half to largest" 
+#' \item{\code{expss.round_half_to_even} }{ Determines which rounding we will use.
+#'  Default rounding is as with R \code{round}: "half to even". For rounding "half to largest" 
 #'  set this option to FALSE. This parameter is supported in the \link[expss]{as.datatable_widget},
 #'  \link[expss]{htmlTable.etable}, \code{print} and in significance testing
 #' methods. \code{NULL} is default and means R default rounding. \code{NA} means no
-#' rounding. Parameter do not affect calculations, only table representation. 
+#' rounding. Parameter does not affect calculations, only table representation. 
 #' There is a convenience function for this option:
 #' \code{expss_round_half_to_even}.}
 #' \item{\code{expss.enable_value_labels_support} }{By default, all labelled
@@ -56,6 +56,9 @@
 #'
 #' @param digits integer. Number of digits after decimal point. \code{NULL} is
 #'   default and means 1 digit. \code{NA} means no rounding.
+#' @param round_half_to_even logical. Default is TRUE which means
+#'  default R rounding: "half to even". For rounding "half to largest" 
+#'  set this option to FALSE.
 #' @param ... list of parameters for \code{huxtable::set_default_properties}.
 #'   See \link[huxtable]{set_default_properties}.
 #' @param label character vector of length 5. Default labels for \link{fre}.
@@ -104,7 +107,7 @@ get_expss_digits = function(){
 
 #' @rdname expss.options
 #' @export
-expss_round_half_to_even = function(round_half_to_even = NULL){
+expss_round_half_to_even = function(round_half_to_even = TRUE){
     options(expss.round_half_to_even = round_half_to_even)
 }