findSimplaceInstallations: Search for simplace installations and returns results as...

findSimplaceInstallationsR Documentation

Search for simplace installations and returns results as vector

Description

Checks directories if they contain simplace_core, simplace_modules and optionally simplace_run (or a data directory given by the user) and returns the matches. There is no check whether the installation is really working.

Usage

findSimplaceInstallations(
  directories = c(),
  tryStandardDirs = TRUE,
  firstMatchOnly = FALSE,
  simulationsDir = "simplace_run",
  ignoreSimulationsDir = FALSE,
  verbose = TRUE
)

Arguments

directories

a list of additional directories where to look -

tryStandardDirs

whether to check for typical installation directories (default)

firstMatchOnly

returns only the first installation found

simulationsDir

directory that contains user simulations (e.g. simplace_run)

ignoreSimulationsDir

don't check for the simulation dir

verbose

prints messages if no or more than one installation found

Details

Beside the checks for some standard directories (like home directory, current working dir and drives c: to g:) and their subdirectories (workspace, simplace, java/simplace) the user can give a vector of additional directories.

Value

matching directory/ies as character vector


simplace documentation built on Aug. 24, 2023, 3:03 p.m.