description updated, fixing some bad descriptions in functions

Author: Davis

DESCRIPTION

@@ -17,3 +17,4 @@ Suggests:
     knitr,
     rmarkdown
 VignetteBuilder: knitr
+RoxygenNote: 7.1.0

R/applytoeachinlist.R

@@ -12,6 +12,8 @@
 #' @param nameaftersplit The name of the argument of applyfun that
 #'   takes the settosplit dataframe after it has been split; this is
 #'   commonly 'x' or 'data'
+#' @param splitalongsidename what should the splitalongside frame be called after
+#'   it has been split? This is commonly something like "newdata"
 #' @param splitalongsidesplitter The name of the factor variable in settosplit, over
 #'   which it should be split.
 #' @return This function returns a named list of results, having applied

R/applytoeachinlistworker.R

@@ -10,6 +10,8 @@
 #' @param nameaftersplit The name of the argument of applyfun that
 #'   takes the settosplit dataframe after it has been split; this is
 #'   commonly 'x' or 'data'
+#' @param splitalongsidename The name of splitalongside after it has been split;
+#'   e.g. this is commonly something like "newdata".
 #' @param splitalongsidesplitter The name of the factor variable in settosplit, over
 #'   which it should be split.
 #' @return This function returns a named list of results, having applied

R/batch_bam.R

@@ -5,14 +5,14 @@
 #'   over which mgcv::bam will be applied.
 #' @param bamargs A named list of arguments to be passed to each bam. For example,
 #'   this could be bamargs=list('formula' = 'y ~ te(x,t)', 'discrete' = TRUE)
-#' @param fallbackargs If the regression defined by bamargs returns an error, any
+#' @param bamargs_fallback If the regression defined by bamargs returns an error, any
 #'   named arguments in this named list overwrite the arguments in bamargs and the
 #'   regression is attempted again. for example, we could have the simpler model
-#'   fallbackargs=list('formula' = 'y ~ s(x))'
+#'   bamargs_fallback=list('formula' = 'y ~ s(x))'
 #' @param over A character string giving the name of the column in data which is
 #'   used to split and pass subsets of the data to bam.
 #' @return This function returns a named list of bam objects, and possibly errors
-#'   if bamargs and fallbackargs fail to produce a model for some levels of over.
+#'   if bamargs and bamargs_fallback fail to produce a model for some levels of over.
 
 batch_bam <- function(data=NULL,
                       bamargs=NULL,

clusterapply.Rproj

@@ -18,3 +18,4 @@ StripTrailingWhitespace: Yes
 BuildType: Package
 PackageUseDevtools: Yes
 PackageInstallArgs: --no-multiarch --with-keep.source
+PackageRoxygenize: rd,collate,namespace