Skip to contents

The installed module identity consists of the package name and its installed version. In R, describeModule() returns a list with the fields package and version: the package name is newmark, and the version is a character string obtained from the installed package. The function takes no arguments.

The command-line operation newmark doctor calls describeModule() and writes that identity to standard output as a JSON object. It requires no input file or project contract and accepts no additional arguments. Its operation belongs to the meta family, with no random-stream consumption or product-file effects. A successful call returns the identity; it does not exercise the numerical models or validate a project’s inputs and products.

newmark --version reports the installed package version together with the path of the command-line script and its build stamp. The build stamp is reported as unknown when the build-information file is absent or contains no build-stamp entry. The package version and the CLI build stamp are separate pieces of information: the former comes from the installed R package, while the latter comes from the build information beside the CLI script. Neither the CLI path nor the build stamp is a field returned by describeModule().

The operation registry describes the callable interface of the installed package. newmark --operations prints this registry as JSON, including each operation’s function, family, route, arguments, result, random-stream behavior and effects. For doctor, the registry names describeModule, declares no arguments and identifies the result fields package and version. newmark doctor --help presents that operation’s interface without calling the identity function. General help, obtained through newmark --help, reads the CLI help text without loading the R package; its availability therefore does not establish that doctor can run.