housekeeping: Prepare environment and file structure

Description Usage Arguments Value Examples

Description

Prepares the environment and your file structure for modelling. This function will conveniently create a results folder, clear the environment, figures, delete previous results, and increase the memory limit if desired.

Usage

1
2
housekeeping(results_folder = "output", env = FALSE, fig = FALSE,
  delete = FALSE, memorylimit = 16304)

Arguments

env

(logical) If TRUE, clears the environment

fig

(logical) If TRUE, clears the figures

delete

(logical) If TRUE, deletes the all the files in the results_folder. WARNING: files are permanently deleted, they will not be in your "recycling bin". Only use TRUE if you are certain you want to delete the files

memorylimit

increases the limit in force on the total memory allocation for Windows machines.

Value

NA

Examples

1
housekeeping(results_folder=results_folder,env=TRUE,fig=TRUE,delete=FALSE,memorylimit=16304)

remi-daigle/BESTMPA documentation built on May 27, 2019, 4:55 a.m.