LG_extract_scripts: Extraction of scripts

In LAJordanger/localgaussSpec: Local Gaussian Spectral Analysis

Extraction of scripts

Description

This function extracts the scripts from the internal file hierarchy of the localgaussSpec-package to a target directory selected by the user.

Usage

LG_extract_scripts(target_dir, overwrite = FALSE)

Arguments

target_dir	The path to the directory where the scripts are to be stored. The user will be asked for permission to create the directory if it does not already exist.
overwrite	Logical value, default FALSE. The default behaviour will be that this function stops if it encounters a non-empty directory. This is done in order to avoid that previously extracted (and potentially modified) versions of the scripts are overwritten. Set overwrite to TRUE in order to override this requirement.

Details

If the target_dir-argument is missing, then the function will print a message that points to this help-page. If target_dir is a non-existing directory, then the user will be asked for permission to create it. If target_dir exists but are non-empty, then it is required that the overwrite-argument must be TRUE in order for the scripts to be extracted.

Value

The result of this function is that copies of the scripts occur in target_dir, and the user can then run them (or modify them) as desired. Read the ReadMe.txt-file in the extracted folder for further details about the structure of the extracted scripts.

LAJordanger/localgaussSpec documentation built on May 6, 2023, 4:31 a.m.