check_for_package: Check if *package* is available

View source: R/utilities.R

check_for_packageR Documentation

Check if *package* is available

Description

Some functions not pertaining to the package core require additional libraries. These libraries are listed as *suggested* in the 'DESCRIPTION' When such a function is called by a user who does not have the respective libraries installed, we should notice that and notify the user. This is the purpose of this *function* 'check_for_package'.

Usage

check_for_package(package, stop = TRUE)

Arguments

package

Name of the package to check for.

stop

Toggle whether an error should be thrown ('TRUE') or a warning generated ('FALSE').

Details

The function checks if *package* is installed and loaded. If not, it either produces a warning or throws an error, depending on the value of *stop*.

Value

‘TRUE' if the package was found. 'FALSE' if it wasn’t found and *stop* is 'FALSE'. Otherwise, an error will be thrown.


growR documentation built on May 29, 2024, 9:12 a.m.