check.version: Check The Version Of The Package

View source: R/check_version.R

check.versionR Documentation

Check The Version Of The Package

Description

This function makes sure that the scripts your running is working with the correct version of RHotStuff. If the version does not match the expectations, the function prompts a warning.

Usage

check.version(expected.version, package = "RHotStuff", strict = FALSE, ...)

Arguments

expected.version

The version (as string) of the package the script was designed to use.

package

The package that will be checked. A vector of packages can't be handled and will be ignored; except the first element of the vector!

strict

If set TRUE, the expected version must match exactly the version of the package. If set FALSE, not matching, but compatible versions will also be excepted.

...

Parameters passed on to packageVersion() function.

Details

This function can check also other packages, but it does not except a vector of package names. The versions must be a string in the format "x.y.z". If the parameter strict is set FALSE, x must match exactly, but two version will be considered equal if y and z are just greater or equal the expected version.

Value

No return value. The function throws a warning if necessary.


AlreadyTakenJonas/RHotStuff documentation built on Oct. 28, 2022, 10:15 p.m.