changed print to warning

Author: lsteinmann

DESCRIPTION

@@ -8,4 +8,4 @@ Description: Converting date ranges into dating 'steps' eases the visualization
 License: CC BY-SA 4.0
 Encoding: UTF-8
 LazyData: true
-RoxygenNote: 6.0.1
+RoxygenNote: 7.0.2

NAMESPACE

@@ -1,4 +1,7 @@
 # Generated by roxygen2: do not edit by hand
 
+export(create.sub.objects)
 export(datsteps)
+export(get.weights)
 export(scaleweight)
+export(switch.dating)

R/datplot_funs.R

@@ -5,38 +5,76 @@
 #' displayed as negative values while dates CE are positive values. Ignoring this will cause problems
 #' in any case.
 #'
-#' @param df a dataframe with 4 variable: ID, group, minimum date (int/num) maximum date (int/num), _must_ be in this order, colnames are irrelevant; each object _must_ be one row.
+#' @param df a dataframe with 4 variables: ID, group, minimum date (int/num) maximum date (int/num), _must_ be in this order, colnames are irrelevant; each object _must_ be one row.
 #' @param stepsize defaults to 5. Number of years that should be used as an interval for creating dating steps.
 #'
 #' @return a larger dataframe with a number of steps for each object as well as a 'weight' value, that is a quantification of how well the object is dated (lesser value means object is dated to larger timespans, i.e. with less confidence)
 #'
 #' @export datsteps
 
-datsteps <- function(df, stepsize = 5) {
+datsteps <- function(df, stepsize = 25) {
   result <- as.data.frame(NULL)
-  if (any(df[,3] > df[,4]) == TRUE) {
-    print(paste("Error: Dating seems to be in wrong order at ",
-                df[which(df[,3] > df[,4]),1],
-                " (Index: ", which(df[,3] > df[,4]), ")",
-                ". Please supply minimum date in 3rd Column, maximum date in 4th.", sep = ""))
-  } else {
-    weights <- get.weights(df[,3], df[,4])
+  if (stepsize == "auto") {
+    timespans <- abs(df[,3] - df[,4])
+    stepsize <- generate.stepsize(timespans)
+  } else if (!is.numeric(stepsize)) {
+    stop(error("stepsize has to be either 'auto' or numeric."))
+  }
 
+  if (any(df[,3] > df[,4])) {
+    warning(paste("Warning: Dating seems to be in wrong order at ID ", paste(df[which(df[,3] > df[,4]),1], collapse = ", "), " (Index: ",
+                  paste(which(df[,3] > df[,4]), collapse = ", "), ")",
+                  ". Dates have been switched, but be sure to check your original data for possible mistakes.", sep = ""))
+    DAT_err <- which(df[,3] > df[,4])
+    df <- switch.dating(df, DAT_err)
+  }
 
-    if (any(weights[,2] == FALSE)) {
-      print(paste("Warning: DAT_min and DAT_max in ",
-                  df[which(weights == FALSE),1],
-                  " (Index: ", which(weights == FALSE), ")",
-                  " have the same value! Is this correct? Please check the table for possible errors.", sep = ""))
-    }
+  weights <- get.weights(df[,3], df[,4])
 
-    df$weight <- weights[,1]
-    result <- create.sub.objects(df, stepsize)
-  }
+  df$weight <- weights[,1]
+  result <- create.sub.objects(df, stepsize)
   return(result)
 }
 
 
+#' Generate stepsize
+#'
+#' Requires a dataframe with 4 variables: ID (ideally factor), group (ideally factor),
+#' minimum date (int/numeric) and maximum date (int/numeric).
+#'
+#' @param df a dataframe with 4 variable: ID, group, minimum date (int/num) maximum date (int/num)
+#'
+#' @return stepsize
+#'
+#' @export switch.dating
+
+generate.stepsize <- function(timespans) {
+  stepsize <- min(abs(df[,4] - df[,3]))
+  if(stepsize < 1) {
+    stepsize <- 1
+  }
+  print(paste("Using stepsize = ", stepsize, " (auto).", sep = ""))
+  return(stepsize)
+}
+
+#' Switch values where dating is in wrong order
+#'
+#' Requires a dataframe with 4 variables: ID (ideally factor), group (ideally factor),
+#' minimum date (int/numeric) and maximum date (int/numeric).
+#'
+#' @param df a dataframe with 4 variable: ID, group, minimum date (int/num) maximum date (int/num)
+#' @param DAT_err a vector containing the dates in wrong order
+#'
+#' @return corrected df
+#'
+#' @export switch.dating
+
+switch.dating <- function(df, DAT_err) {
+  df[DAT_err,3:4] <- df[DAT_err,4:3]
+  return(df)
+}
+
+
 #' Calculate the weights for each dated object
 #'
 #' Requires a dataframe with 4 variables: ID (ideally factor), group (ideally factor),
@@ -61,9 +99,18 @@ get.weights <- function(DAT_min, DAT_max) {
     weights[which(weights[,1] == 0),1] <- 1
   }
   weights[,1] <- 1/weights[,1]
+  if (any(weights[,2] == FALSE)) {
+    warning(paste("Warning: DAT_min and DAT_max in ID ",
+                  paste(df[which(weights[,2] == FALSE),1], collapse = ", "),
+                  " (Index: ", paste(which(weights[,2] == FALSE), collapse = ", "), ")",
+                  " have the same value! Is this correct? Please check the table for possible errors.", sep = ""))
+  }
   return(weights)
 }
 
+
+
+
 #' Create sub-objects for each object in a dataframe
 #'
 #' Requires a dataframe with 5 variables: ID (ideally factor), group (ideally factor),
@@ -83,17 +130,29 @@ create.sub.objects <- function(df, stepsize) {
 
   mean_year_index <- which(df[,4]-df[,3] < stepsize)
 
-  outputnr <- ceiling(sum(((abs(df[-mean_year_index,3]-df[-mean_year_index,4]))/stepsize)+1))
-  outputnr <- outputnr+length(mean_year_index)
+  if (length(mean_year_index) == 0) {
+    outputnr <- ceiling(sum(((abs(df[,3]-df[,4]))/stepsize)+1))
+  } else {
+    outputnr <- ceiling(sum(((abs(df[-mean_year_index,3]-df[-mean_year_index,4]))/stepsize)+1))
+    outputnr <- outputnr+length(mean_year_index)
+  }
+
+  result <- as.data.frame(matrix(ncol = ncol(df)+1, nrow = outputnr+100))
 
-  result <- as.data.frame(matrix(ncol = ncol(df)+1, nrow = outputnr))
 
   colnames(result) <- c(colnames(df), "DAT_step")
+  diffs <- df[,4]-df[,3]
+
+  if (any(diffs < stepsize)) {
+    diffs <- diffs[diffs < stepsize]
+    warning(paste("stepsize is larger than the range of the closest dated object: ",
+                paste(df[which(diffs < stepsize),1], collapse = ", "), " (Index = ",
+                paste(which(diffs < stepsize), collapse = ", "), "). Using mean as year.", sep = ""))
+  }
+
   for (i in 1:nrow(df)) {
     sequence <- NULL
     if ((df[i,4]-df[i,3]) < stepsize) {
-      print(paste("stepsize is larger than the range of the closest dated object: ",
-                  df[i,1], " (Index = ", i, "). Using mean as year.", sep = ""))
       sequence <- (df[i,3]+df[i,4])/2
     } else {
       sequence <- seq(df[i,3], df[i,4], by = stepsize)

datplot.Rproj

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