openModules: Open all modules nested within a base directory

In SpaDES.core: Core Utilities for Developing and Running Spatially Explicit Discrete Event Models

Open all modules nested within a base directory

Description

This is just a convenience wrapper for opening several modules at once, recursively. A module is defined as any file that ends in .R or .r and has a directory name identical to its filename. Thus, this must be case sensitive.

Usage

openModules(name, path)

## S4 method for signature 'character,character'
openModules(name, path)

## S4 method for signature 'missing,missing'
openModules()

## S4 method for signature 'missing,character'
openModules(path)

## S4 method for signature 'character,missing'
openModules(name)

## S4 method for signature 'simList,missing'
openModules(name)

Arguments

name	Character vector with names of modules to open. If missing, then all modules will be opened within the base directory.
path	Character string of length 1. The base directory within which there are only module subdirectories.

Value

Nothing is returned. All file are open via file.edit.

Note

On Windows there is currently a bug in RStudio that prevents the editor from opening when file.edit is called. file.edit does work if the user types it at the command prompt. A message with the correct lines to copy and paste is provided.

Author(s)

Eliot McIntire

Examples

if (interactive())
  openModules("modules")

SpaDES.core documentation built on Nov. 10, 2023, 5:08 p.m.