install_asreml: Install ASreml-R package

In biometryhub/BiometryTools: A Suite of Functions for Conducting Post Analysis Tasks with ASReml-R V4 Models tasks with ASReml-R V4 models

Install ASreml-R package

Description

A helper function for installing the ASreml-R package, intended to reduce the difficulty of finding the correct version for your operating system and R version.

Usage

install_asreml(
  library = .libPaths()[1],
  quiet = FALSE,
  force = FALSE,
  keep_file = FALSE
)

Arguments

library	Library location to install ASreml-R. Uses first option in .libPaths() by default.
quiet	Logical (default FALSE). Should package be installed quietly?
force	Logical (default FALSE). Force ASreml-R to install. Useful for upgrading if it is already installed.
keep_file	Should the downloaded asreml package file be kept? Default is FALSE. TRUE downloads to current directory. A file path can also be provided to save to another directory. See Details for more information.

Details

The package file is downloaded from a shortlink, and if keep_file is TRUE, the package archive file will be saved in the current directory. If a valid path is provided in keep_file, the file will be saved to that path, but no directory will be created. If keep_file does not specify an existing, valid path, an error will be shown.

Value

Silently returns TRUE if asreml installed successfully or already present, FALSE otherwise. Optionally prints a confirmation message on success.

biometryhub/BiometryTools documentation built on July 14, 2024, 4:42 p.m.