camtrapR (version 0.97.0)

imageRename: Copy and rename images based on containing directories and creation date

Description

The function copies images into a new location and renames them with camera trap station ID, camera ID (optional), creation date and a numeric identifier for images taken within one minute of each other at a given station. Station ID and camera ID are derived from the directory structure. The creation date is extracted from image metadata using Exiftool.

Usage

imageRename(inDir, 
  outDir, 
  hasCameraSubfolders,
  copyImages = FALSE, 
  writecsv = FALSE)

Arguments

inDir

character. Directory containing camera trap station subdirectories

outDir

character. Directory into which the renamed images will be copied

hasCameraSubfolders

logical. Do the station subdirectories of inDir have camera-subdirectories?

copyImages

logical. Copy images to outDir?

writecsv

logical. Save a data frame with a summary as a .csv?

Value

• A data frame with original directories and file names, new directories and file names and an indicator whether images were copied successfully.

Details

Setting up the correct folder structure is necessary for running the function successfully. inDir is the main folder containing subdirectories for each camera trap station. If there was more than one camera at a station, there must be further subdirectories for the individual camera traps at a station and hasCameraSubfolders must be set to TRUE. Within camera directories, directory structure is irrelevant. If there was one camera per station only, hasCameraSubfolders can be set to TRUE and the function will only look for images in the station subdirectories of inDir. The function recursively searches for all .jpg images in the subdirectories of inDir, extracts the creation date using Exiftool and copies the images into outDir, where it will set up subdirectories based on the camera trap station IDs. Following the execution of this function, species are identified by moving image files into species subdirectories of each camera trap station directories in outDir.

References

Phil Harvey's Exiftool http://www.sno.phy.queensu.ca/~phil/exiftool/

Examples

### "trial" run. create a table with file names after renaming, but don't copy images.

# first, find sample image directory in package directory:
wd_images_raw <- system.file("pictures/raw_images", package = "camtrapR")

if (Sys.which("exiftool") != ""){        # only run this example if Exiftool is available
renaming.table <- imageRename(inDir = wd_images_raw,
 # outDir = getwd(),       # because copyImages = FALSE, outDir does not need to be defined
  hasCameraSubfolders = FALSE,
  copyImages = FALSE,
  writecsv = FALSE
  )
  } else {
  print("Exiftool is not available. Cannot test function")
  }
  
  # define image directories

  # raw image location
wd_images_raw <- system.file("pictures/raw_images", package = "camtrapR")      
  # destination for renamed images
wd_images_raw_renamed <- paste(getwd(), "raw_images_renamed", sep = "/")       


  if (Sys.which("exiftool") != ""){        # only run this example if Exiftool is available
renaming.table2 <- imageRename(inDir = wd_images_raw,
  outDir = wd_images_raw_renamed,       # now, copyImages = TRUE, so we have to set outDir
  hasCameraSubfolders = FALSE,
  copyImages = TRUE,
  writecsv = FALSE
  )
  }
  
  list.files(wd_images_raw_renamed, recursive = TRUE)