Run the following code to install and licence ASReml-R:
Then paste your licence code at the prompt.
ASReml-R is a proprietary R package which is sold and supported by VSN International, and requires a licence code to activate and run. This licence code is checked for validity via the internet, and may require opening some network ports on your computer to successfully activate. Further information about the licence requirements can be obtained from VSNi directly.
The developers of biometryassist do not provide support for
ASReml-R via way of bug reports or software patches, and
any problems with the ASReml-R software should be directed to VSN International. These installation
instructions are provided on a best-effort basis and any problems with
the steps in this installation guide should be reported to the
As of June 2023, the University of Adelaide has unlimited licence codes until June 2026 for university staff, students and affiliates, thanks to funding provided by the Grains Research and Development Corporation, via the Analytics for the Australian Grains Industry (AAGI) project.
To access the University of Adelaide licence key, please complete this form: https://forms.office.com/r/gBva4iL3FU
You will receive an email with a licence key if you hold a valid University of Adelaide account.
The easiest way to install ASReml-R is to use the
biometryassist package, which includes an automated
install_asreml() function. This function will detect the
appropriate version of R and your operating system, and download the
matching version of asreml. If you’d rather not install the full package
for this one function, you can simply source the function from the
public GitHub repository instead, and run the function. See Function Only Method.
biometryassist package is on CRAN, so can be
installed using the regular method:
Once installed, load the package ready for use with:
This package will stay installed between R sessions, but will need to be loaded with the library command any time you want to use the functions within it.
To use only the function, without the additional overhead of the biometryassist package, source it with the following command:
This will enable use of the function within the current R session. If
you close R, you will need to run the line above again to enable use of
the function. Note this requires the packages
curl to be installed, which is accomplished in the first
line above if necessary.
Once the install function is available, simply run it and wait for it to finish:
The following output is typical:
> install_asreml() Downloading and installing ASReml-R. This may take some time, depending on internet speed... * installing *source* package ‘asreml’ ... ** using staged installation ** R ** data *** moving datasets to lazyload DB ** inst ** byte-compile and prepare package for lazy loading ** help *** installing help indices ** building package indices ** testing if installed package can be loaded from temporary location ** checking absolute paths in shared objects and dynamic libraries ** testing if installed package can be loaded from final location ** testing if installed package keeps a record of temporary installation path * DONE (asreml) ASReml-R successfully installed!
To activate the licence code once asreml is installed, run the following commands (noting the spelling of license):
You will then be prompted to provide a licence code, which is a 16 character alpha-numeric code:
A valid licence code will produce the following output:
License activation successful Licensed to <Orginisation or name> - <reference code(s)> Ref: <reference code> Expires: <expiry date>, <n> days.
install_asreml() function has a number of additional
arguments, which you can read about on
the documentation site.
If you already have ASReml-R installed, and want to update it or
reinstall it, you can use the
update_asreml() function, or
install_asreml(force = TRUE).
This vignette was last updated on 2023-07-03.