ap2dme: Download and Make Example Experiment

In bpollner/aquap2: Multivariate Data Analysis Tools for R including Aquaphotomics Methods

Download and Make Example Experiment

Description

Checks if a dataset is present. If not, it is downloading a single example experiment from a server, generating the required folder structure and inserting the downloaded files into their appropriate folder.

Usage

ap2dme(where, expName, ffs = FALSE, fdo = FALSE, sh = NULL)

Arguments

where	Character length one. The path where the experiment home folder should be looked for. The experiment home folder, if already existing, has to end in @home in order to be recognized correctly.
expName	Character length one, the name of the experiment.
ffs	Logical. If the folder structure should be generated in all cases. If set to TRUE and where is pointing to an already existing experiment home folder, the latter one will be deleted and a new folder structure will be created.
fdo	Logical. If the download should always be enforced
sh	Character length one. The path to settings home. Can and should be left at the default NULL.

Details

The experiment home folder, if already present, has to end in @home in order to be recognized correctly. If the experiment home folder does not exist it will be created. Currently, this function is primary intended to be used in testing and to help create executable examples. The downloaded folder containing all available example datasets is stored in tempdir(). If already present, it will not be downloaded again.

Value

Used for its side effect, i.e. do (possibly) download example data and to create a working experiment folder structure. Returns NULL if no data were downloaded, FALSE if data should have been downloaded but it failed, and TRUE if data were possibly downloaded, the experiment folder structure was created successfully, and the data files were copied.

See Also

Other Helper Functions: ap2_settings_setup(), export_ap2_ToXlsx(), export_header_toXls(), genFolderStr(), genNoiseRecExp(), genTempCalibExp(), getcd(), getcm(), getstn(), printStdColnames(), reColor(), saveAQdata(), siWlg(), updateSettings()

bpollner/aquap2 documentation built on March 29, 2024, 7:33 a.m.