testPerl: Test Perl installation and required modules for WriteXLS()

View source: R/testPerl.R

testPerlR Documentation

Test Perl installation and required modules for WriteXLS()

Description

Test Perl installation and required modules for WriteXLS()

Usage

  testPerl(perl = "perl", verbose = TRUE)

Arguments

perl

Name of the perl executable to be called.

verbose

Output test result messages.

Details

This function will test your current system to be sure that Perl is installed and if so, whether or not all of the Perl modules required for WriteXLS() are present.

Success and/or error messages as appropriate will be output.

Value

A boolean value (TRUE or FALSE). TRUE if Perl and ALL required modules are found

Note

Please be sure to read the included INSTALL file (in the main package installation directory) for additional details on meeting the requirements for Perl and the additional Perl modules that are necessary for WriteXLS to work properly. The file includes platform specific recommendations for common scenarios. The path to the package installation directory can be located using system.file(package = "WriteXLS").

A working installed version of Perl must be present in the current system searchpath or the exact path of the perl executable must be provided via the perl argument. Perl modules required for this function that may not be part of a default Perl installation are included with this package. These modules include:

Archive::Zip, OLE::Storage_Lite, Parse::RecDescent, Spreadsheet::WriteExcel, Excel::Writer::XLSX and Text::CSV_PP

File::Basename and Getopt::Long are "Core" Perl modules and should be part of a standard Perl installation, however, they are both included in WriteXLS as a fall back.

Author(s)

Marc Schwartz marc_schwartz@me.com

Many thanks to Prof. Brian Ripley for his assistance in the testing of this package.

See Also

WriteXLS


WriteXLS documentation built on Sept. 11, 2024, 6:18 p.m.

Related to testPerl in WriteXLS...