Package 'zerenebatchR'

Title: Utility for Batch Processing in Zerene Stacker
Description: Writes Zerene Stacker batch files and executes them from the commandline.
Authors: Ethan Bass
Maintainer: Ethan Bass <[email protected]>
License: MIT + file LICENSE
Version: 0.2.3
Built: 2024-11-17 04:39:36 UTC
Source: https://github.com/ethanbass/zerenebatchr

Help Index

Expand data.frame

Description

This function facilitates stacking photos that are numbered sequentially. It must be supplied with a data.frame with columns containing the information about the images to be stacked.

Usage

expand_zs_dataframe(
  df,
  c_path,
  c_id,
  c_start,
  c_end,
  extension = "JPG",
  digits = 4
)

Arguments

df

A data.frame containing the first and last photo, file path, and grouping variable.
c_path

String or numerical index specifying the column where the file paths can be found. Paths should
c_id

String or numerical index specifying column where factor can be found for grouping images.
c_start

String or numerical index specifying the column containing the first photo of each stack.
c_end

String or numerical index specifying the column containing the last photo of each stack.
extension

String specifying the file extension of the images. The extension must be in the correct case so it matches exactly to the extension of the files to be stacked.
digits

How many digits should be in the number.

Value

Expanded data.frame

Create and run batch scripts in Zerene Stacker

Description

Create and run batch scripts in Zerene Stacker

Usage

run_zs_batch(
  files,
  c_split = 1,
  c_path = 2,
  path_out,
  stacker = c("pmax", "dmap"),
  temp,
  path_template = NULL,
  path_xml = NULL,
  stack = TRUE
)

Arguments

files

A data.frame or character vector. If stack == TRUE, a data.frame should be provided with at least 2 columns containing the paths of the files to parse (c_path) and a grouping factor (c_split). If stack == FALSE, a character vector should be provided containing paths to the stacked files.
c_split

String or numerical index specifying column where factor can be found for grouping images.
c_path

String or numerical index specifying column where paths can be found.
path_out

directory to export converted files.
stacker

Which stacking algorithm to use. Either pmax or dmap.
temp

Logical. If TRUE, the function will stack files into a temp directory which will be deleted when the operation is completed. Thus, the organization of the original image files will be maintained. Otherwise, images will be moved permanently into new folders according to the provided grouping variable. Defaults to TRUE.
path_template

Path to custom template to be customized according to the provided arguments (optional).
path_xml

path to write xml file (optional).
stack

Logical. Whether to stack the files or not. Defaults to TRUE.

Value

No return value.

Side effects

Images will be stacked according to the provided grouping variable, a Zerene Stacker batch file will be generated, and images will be stacked into the folder specified by path_out.

Author(s)

Ethan Bass

Stack files in folders

Description

Stack files in folders

Usage

stack_files(df, c_path, c_split, temp = TRUE)

Arguments

df

data.frame containing at least 2 columns containing the paths of the files to parse and a grouping factor.
c_path

String or numerical index specifying column where paths can be found.
c_split

String or numerical index specifying column where factor can be found for grouping images.
temp

Logical. If TRUE, the function will stack files into a temp directory which will be deleted when the operation is completed. Thus, the organization of the original image files will be maintained. Otherwise, images will be moved permanently into new folders according to the provided grouping variable. Defaults to TRUE.

Author(s)

Ethan Bass