docs fix

R/capacity_logreg_testing.R

@@ -6,7 +6,7 @@
 #'
 #' If side variables are added within the analysis (side_variables is not NULL), two additional procedures are carried out:
 #' reshuffling test and reshuffling with bootstrap test, which are based on permutation of side variables values within the dataset.  
-#' Additional parameters: lr_maxit and maxNWts are the same as in definition of multinom function from nnet package. An alternative
+#' Additional parameters: lr_maxit and MaxNWts are the same as in definition of multinom function from nnet package. An alternative
 #' model formula (using formula_string arguments) should be provided if  data are not suitable for description by logistic regression
 #' (recommended only for advanced users).
 #'
@@ -23,7 +23,7 @@
 #' If NULL, a standard additive model of response variables is assumed. Only for advanced users.
 #' @param cc_maxit is the number of iteration of iterative optimisation of the algorithm to estimate channel capacity. Default is 100.
 #' @param lr_maxit is a maximum number of iteration of fitting algorithm of logistic regression. Default is 1000.
-#' @param maxNWts is a maximum acceptable number of weights in logistic regression algorithm. Default is 5000.
+#' @param MaxNWts is a maximum acceptable number of weights in logistic regression algorithm. Default is 5000.
 #' @param TestingSeed is the seed for random number generator used in testing procedures
 #' @param boot_num is the number of bootstrap tests to be performed. Default is 10, but it is recommended to use at least 50 for reliable estimates.
 #' @param boot_prob is the proportion of initial size of data to be used in bootstrap. Default is 0.8.

R/mi_logreg_testing.R

@@ -6,7 +6,7 @@
 #'
 #' If side variables are added within the analysis (side_variables is not NULL), two additional procedures are carried out:
 #' reshuffling test and reshuffling with bootstrap test, which are based on permutation of side variables values within the dataset.  
-#' Additional parameters: lr_maxit and maxNWts are the same as in definition of multinom function from nnet package. An alternative
+#' Additional parameters: lr_maxit and MaxNWts are the same as in definition of multinom function from nnet package. An alternative
 #' model formula (using formula_string arguments) should be provided if  data are not suitable for description by logistic regression
 #' (recommended only for advanced users).
 #'
@@ -23,7 +23,7 @@
 #' @param formula_string (optional) is a character object that includes a formula syntax to use in logistic regression model. 
 #' If NULL, a standard additive model of response variables is assumed. Only for advanced users.
 #' @param lr_maxit is a maximum number of iteration of fitting algorithm of logistic regression. Default is 1000.
-#' @param maxNWts is a maximum acceptable number of weights in logistic regression algorithm. Default is 5000.
+#' @param MaxNWts is a maximum acceptable number of weights in logistic regression algorithm. Default is 5000.
 #' @param TestingSeed is the seed for random number generator used in testing procedures
 #' @param boot_num is the number of bootstrap tests to be performed. Default is 10, but it is recommended to use at least 50 for reliable estimates.
 #' @param boot_prob is the proportion of initial size of data to be used in bootstrap

R/output_graphs_main.R

@@ -6,7 +6,7 @@
 #' @param response is a character vector that indicates columns of data that should be treated as channel's output
 #' @param side_variables is a character vector that indicates side variables' columns of data
 #' @param cc_output a list that is a standard output of capacity_logreg_algorithm function
-#' @param path character giving the directory, where graphs should be saved
+#' @param output_path character giving the directory, where graphs should be saved
 #' @param height integer indicating the height of a single plot
 #' @param width integer indicating the width of a single plot
 #' @return A list with ggplot or gtable object. Each plot is also saved in `output_path` directory in separate pdfs files which include: