checkFiles: Checks whether all specified files are valid R or Python...

In mmstat4: Access to Teaching Materials from a ZIP File or GitHub

Checks whether all specified files are valid R or Python files

Description

checkFiles checks whether all specified files are valid source files that can be executed independently of each other. If an error occurs then:

1. If open is a function name or a function with a file parameter, then checkFiles will try to open the faulty source file, otherwise not.

2. The execution of checkFiles is stopped.

If you do not want the faulty source file to be opened immediately, use open=0.

Three modes are available for checking a file:

1. exist: Does the source file exist?

2. parse: (default) is parse(file) or ⁠python -m "file"⁠ successful?

3. run: is ⁠Rscript "file"⁠ or ⁠python "file"⁠ successful?

If source files has side effects, e.g. generating an image or some other output, and mode=="parse" then this will done during the check.

Usage

checkFiles(
  files,
  index = seq_along(files),
  path = NULL,
  open = openFile,
  mode = c("parse", "run", "exist"),
  ...
)

Rsolo(
  files,
  index = seq_along(files),
  path = NULL,
  open = openFile,
  mode = c("parse", "run", "exist"),
  ...
)

Arguments

files	character: file name(s)
index	integer(s): if length(index)==1 the files from index to length(files) are checked (default: seq_along(files)) otherwise the files with values in index are checked.
path	character: path to start from (default: getwd())
open	function: function or function name to call after an error occurs (default: openFile)
mode	character which check to do
...	further parameters given to the function in open

Value

nothing

Examples

if (interactive()) {
  files <- list.files(pattern="*.(R|py)$", full.names=TRUE, recursive=TRUE)
  checkFiles(files)
}

mmstat4 documentation built on May 29, 2024, 11:15 a.m.