check: Check Package is Ready to Use

Description Usage Arguments Value Author(s)

View source: R/api.R

Description

Check that a package is ready for use with RcppR6. This just checks for our requirements and prints diagnostics. It is probably unsufficient, but hopefully provides enough information.

Usage

1
check(path = ".", error = TRUE, quiet = FALSE)

Arguments

path

Path to the package

error

Logical indicating if problems should be treated as errors

quiet

Logical indicating if a description of problems should be printed.

Value

An invisible logical value indicating if the package looks ready for use with RcppR6. However, if the package is not ready and error is TRUE, then nothing is returned as the function will throw an error.

Author(s)

Rich FitzJohn


richfitz/RcppR6 documentation built on May 27, 2019, 8:15 a.m.