Update to documentation of auto_crop.R

source/auto_crop.R

+#' A cropping function
+#'
+#' This function identifies meiotic nuclei and crops them.
+#' @keywords synapsis
+#' @export
+#' @examples
+#' To use the "crop" function on a folder of images, apply the following three lines of code
+#' path = "/folder_of_your_images"
+#' files <- list.files(path)
+#' crop(files, "/folder_of_your_images")
+#' 
+#' # set the path below to where your jpegs are located
+#' # to save the cropped images, make a folder called "crops" which in "/folder_of_your_images" in other words "/folder_of_your_images/crops"
 crop <- function(file_list, img_path, crop_method = "regular")
 {
   # input :