cruncher_and_param: Combined cruncher launcher

View source: R/Cruncher.R

cruncher_and_paramR Documentation

Combined cruncher launcher

Description

Function to simultaneously crunch a workspace and create its .params file

Usage

cruncher_and_param(
  workspace = workspace,
  cruncher_bin_directory = getOption("cruncher_bin_directory"),
  rename_multi_documents = TRUE,
  output = NULL,
  delete_existing_file = NULL,
  log_file = NULL,
  ...
)

Arguments

workspace

path to the workspace.

cruncher_bin_directory

path to the cruncher "bin" folder.

rename_multi_documents

boolean indicating whether to rename the output folders to the crunched multiprocessings' names. By default, rename_multi_documents = TRUE. If rename_multi_documents = FALSE, the multiprocessings' xml files' names are used.

output

folder containing the cruncher results. By default, (output = NULL) and an "Output" folder is created within the workspace folder.

delete_existing_file

boolean indicating whether to delete pre-existing files when renaming the folders. Only used when rename_multi_documents = TRUE. By default, (delete_existing_file = NULL) and a dialogue box opens, asking whether to delete the files.

log_file

log file name. By default, no log file is generated.

...

other parameters of the function create_param_file.

Value

The workspace path.

See Also

Traduction française

Other Cruncher functions: create_param_file(), cruncher(), update_workspace()


AQLT/JDCruncheR documentation built on March 20, 2024, 2:32 p.m.