getOfficialRstoxPackageVersion: Get certified Rstox package versions

In StoXProject/RstoxFramework: The Engine of StoX

Get certified Rstox package versions

Description

This function reads the OfficialRstoxFrameworkVersions.txt file for the given StoX GUI version.

Usage

getOfficialRstoxPackageVersion(
  StoXVersion = NULL,
  officialRstoxPackageVersionsFile = system.file("versions",
    "OfficialRstoxFrameworkVersions.txt", package = "RstoxFramework"),
  optionalDependencies = FALSE,
  toJSON = FALSE,
  list.out = FALSE
)

Arguments

StoXVersion	The version of the StoX GUI defining the combination of official Rstox package versions.
officialRstoxPackageVersionsFile	The path to the file holding the link between StoX GUI version and Rstox package versions. If missing, the file on the RstoxFramework master on GitHub is used ("https://raw.githubusercontent.com/StoXProject/RstoxFramework/master/inst/versions/OfficialRstoxFrameworkVersions.txt").
optionalDependencies	Logical: If TRUE include also the column OptionalDependencies from the OfficialRstoxFrameworkVersions.txt file, which holds Rstox packages used in the Suggests field of the DESCRIPTION file.
toJSON	Logical: If TRUE output a JSON string.
list.out	Logical: If TRUE wrap the output of getOfficialRstoxPackageVersion in a list with packageName and version.

StoXProject/RstoxFramework documentation built on Oct. 17, 2023, 1:24 p.m.