chadwick_path: Check Chadwick installation

In BillPetti/baseballr: Acquiring and Analyzing Baseball Data

Check Chadwick installation

Description

Utility functions to help ensure that Chadwick is set up correctly.

The easiest way for the Chadwick CLI tools to work on *nix systems is to set the LD_LIBRARY_PATH environment variable. Unfortunately this environment variable is not set by default during the Chadwick installation.

chadwick_ld_library_path() checks to find the Chadwick shared libraries, and then set the LD_LIBRARY_PATH environment variable. If chadwick_ld_library_path() returns TRUE, the cwevent command line program that retrosheet_data depends on should work.

The other functions documented here are mostly for internal use.

Usage

chadwick_path()

chadwick_is_installed()

chadwick_find_lib()

chadwick_set_ld_library_path()

chadwick_ld_library_path()

Value

If Chadwick is not installed NULL. If Chadwick is installed, the path to the cwevent binary.

TRUE or FALSE

Path to the Chadwick shared library.

See Also

retrosheet_data()

Examples

chadwick_path()

chadwick_is_installed()

chadwick_find_lib()
## Not run: 
if (chadwick_ld_library_path()) {
  retrosheet_data(tempdir())
}

## End(Not run)

BillPetti/baseballr documentation built on April 17, 2024, 6:21 a.m.