documentation of get.historamscale()

Author: lsteinmann

R/get.histogramscale.R

@@ -1,11 +1,24 @@
 #' @title Scaling Factor for Combined Histogramm Plots
 #'
-#' @description Requires a dataframe as produced by datsteps(). (Meaning 6 columns in the following order: ID, group, minimum/earliest date, maximum/latest date, weight, 'DAT_Steps')
+#' @description Requires a dataframe as produced by datsteps().
+#' Meaning 6 columns in the following order:
+#' * ID,
+#' * group,
+#' * minimum/earliest date,
+#' * maximum/latest date,
+#' * weight,
+#' * 'DAT_Steps'
 #'
 #' @param DAT_df a dataframe as returned by datsteps
-#' @param bw the bandwidtg to use. shoudl be stepsize used to compute the dataframe, and if a df as returned by datsteps() is automatically assigned
+#' @param bw the bandwidth to use for the density function and histogram. Should be stepsize used to
+#' create the dataframe. If a df as returned by datsteps() is given, stepsize is automatically assigned
+#' using the corresponding attribute.
 #'
-#' @return the factor with which to scale the density curve to a histogram plot
+#' @return the value with which to scale the density curve to a histogram plot so that both will be visible
+#'
+#' @examples
+#' DAT_df_steps <- datsteps(DAT_df[1:100,], stepsize = 25)
+#' get.histogramscale(DAT_df_steps)
 #'
 #' @export get.histogramscale
 
@@ -14,10 +27,10 @@ get.histogramscale <- function(DAT_df, bw = "auto") {
     if (!is.null(attributes(DAT_df)$stepsize)) {
       bw <- attributes(DAT_df)$stepsize
     } else {
-      stop("Either specify stepsize or use a data.frame as returned by datsteps()")
+      stop("Either specify stepsize/bandwidth (bw = ) or use a data.frame as returned by datsteps()")
     }
   } else if (!is.numeric(bw)) {
-    stop("Either specify stepsize or use a data.frame as returned by datsteps()")
+    stop("Either specify stepsize/bandwidth (bw = ) or use a data.frame as returned by datsteps()")
   }
   density <- density(DAT_df$DAT_step, weights = DAT_df$weight, bw = bw)
   breaks <- range(DAT_df$DAT_step)