Skip to content

Commit

Permalink
Updating asreml instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
@rogerssam
rogerssam committed Sep 11, 2023
1 parent bbe5175 commit f569e73
Show file tree
Hide file tree
Showing 3 changed files with 42 additions and 29 deletions.
45 changes: 30 additions & 15 deletions docs/installing-asreml.html
View file
Original file line number Diff line number Diff line change
Expand Up @@ -6,8 +6,8 @@

<meta name="viewport" content="width=device-width, initial-scale=1.0, user-scalable=yes">

<meta name="author" content=" Biometry Hub, University of Adelaide ">
<meta name="author" content=" [email protected] ">
<meta name="author" content="Biometry Hub, University of Adelaide">
<meta name="author" content="[email protected]">

<title>Installing ASReml-R</title>
<style>
Expand Down Expand Up @@ -98,22 +98,41 @@

</head>

<body class="fullcontent">
<body>

<div id="quarto-search-results"></div>
<!-- content -->
<div id="quarto-content" class="quarto-container page-columns page-rows-contents page-layout-article">
<!-- sidebar -->
<!-- margin-sidebar -->

<div id="quarto-margin-sidebar" class="sidebar margin-sidebar">
<nav id="TOC" role="doc-toc" class="toc-active">
<h2 id="toc-title">On this page</h2>

<ul>
<li><a href="#introduction" id="toc-introduction" class="nav-link active" data-scroll-target="#introduction">Introduction</a></li>
<li><a href="#asreml-r-installation" id="toc-asreml-r-installation" class="nav-link" data-scroll-target="#asreml-r-installation">ASReml-R Installation</a>
<ul class="collapse">
<li><a href="#biometryassist" id="toc-biometryassist" class="nav-link" data-scroll-target="#biometryassist">biometryassist</a></li>
<li><a href="#asreml-r" id="toc-asreml-r" class="nav-link" data-scroll-target="#asreml-r">ASReml-R</a></li>
<li><a href="#activate-asreml-r" id="toc-activate-asreml-r" class="nav-link" data-scroll-target="#activate-asreml-r">Activate ASReml-R</a></li>
</ul></li>
<li><a href="#additional-packages-optional" id="toc-additional-packages-optional" class="nav-link" data-scroll-target="#additional-packages-optional">Additional Packages (Optional)</a>
<ul class="collapse">
<li><a href="#cran-packages" id="toc-cran-packages" class="nav-link" data-scroll-target="#cran-packages">CRAN packages</a></li>
<li><a href="#github-packages" id="toc-github-packages" class="nav-link" data-scroll-target="#github-packages">GitHub packages</a></li>
<li><a href="#other-packages" id="toc-other-packages" class="nav-link" data-scroll-target="#other-packages">Other packages</a></li>
</ul></li>
<li><a href="#Further" id="toc-Further" class="nav-link" data-scroll-target="#Further">Further resources</a></li>
</ul>
</nav>
</div>
<!-- main -->
<main class="content" id="quarto-document-content">

<header id="title-block-header" class="quarto-title-block default">
<div class="quarto-title">
<h1 class="title"><center><br>
Installing and Configuring R and Rstudio with ASReml-R<br>
</center></h1>
<h1 class="title">Installing and Configuring R and Rstudio with ASReml-R</h1>
</div>


Expand All @@ -123,19 +142,15 @@ <h1 class="title"><center><br>
<div>
<div class="quarto-title-meta-heading">Authors</div>
<div class="quarto-title-meta-contents">
<p></p><center><br>
Biometry Hub, University of Adelaide<br>
<center> <p></p>
<p></p><center><br>
[email protected]<br>
<center> <p></p>
</center></center></center></center></div>
<p>Biometry Hub, University of Adelaide </p>
<p>[email protected] </p>
</div>
</div>

<div>
<div class="quarto-title-meta-heading">Published</div>
<div class="quarto-title-meta-contents">
<p class="date">Invalid Date</p>
<p class="date">September 2023</p>
</div>
</div>

Expand Down
12 changes: 6 additions & 6 deletions docs/search.json
View file
Original file line number Diff line number Diff line change
Expand Up @@ -37,42 +37,42 @@
{
"objectID": "installing-asreml.html#biometryassist",
"href": "installing-asreml.html#biometryassist",
"title": "\nInstalling and Configuring R and Rstudio with ASReml-R\n",
"title": "Installing and Configuring R and Rstudio with ASReml-R",
"section": "biometryassist",
"text": "biometryassist\nYou will need the biometryassist package, which can be installed from CRAN via\n\nif(!require(biometryassist)) install.packages(\"biometryassist\")"
},
{
"objectID": "installing-asreml.html#asreml-r",
"href": "installing-asreml.html#asreml-r",
"title": "\nInstalling and Configuring R and Rstudio with ASReml-R\n",
"title": "Installing and Configuring R and Rstudio with ASReml-R",
"section": "ASReml-R",
"text": "ASReml-R\nOnce biometryassist is installed, the latest version of ASReml-R can then be installed with the commands\n\nlibrary(biometryassist)\ninstall_asreml()\n\nThe install_asreml() function comes from the biometryassist package, hence the need to install and load that first.\nAll going well, you should get a confirmation that ASReml-R is installed successfully."
},
{
"objectID": "installing-asreml.html#activate-asreml-r",
"href": "installing-asreml.html#activate-asreml-r",
"title": "\nInstalling and Configuring R and Rstudio with ASReml-R\n",
"title": "Installing and Configuring R and Rstudio with ASReml-R",
"section": "Activate ASReml-R",
"text": "Activate ASReml-R\nAfter you have installed ASReml-R, you will need to activate it. To do this, you will need to provide a licence code from VSNi, and possibly open two ports on your computer to allow communication over the internet with the VSNi licence server. To enter the licence code, use the following commands:\n\nlibrary(asreml)\nasreml.license.activate()\n\nThis will result in a prompt such as:\nPlease enter your activation code (RET or 0 to exit): \nThe licence code is usually in the format AAAA-BBBB-CCCC-DDDD. Once entered, your computer will connect to the VSNi licence server to check the code is correct, and you will be informed of the outcome.\nA successful licence activation will result in a message like the following:\nLicensed to ABcDEfg\nRef: ABC12345 Expires: 2023-06-30, 487 days."
},
{
"objectID": "installing-asreml.html#cran-packages",
"href": "installing-asreml.html#cran-packages",
"title": "\nInstalling and Configuring R and Rstudio with ASReml-R\n",
"title": "Installing and Configuring R and Rstudio with ASReml-R",
"section": "CRAN packages",
"text": "CRAN packages\nMost packages for R are available on CRAN, and can be installed with the following command:\n\ninstall.packages(c(\"ASMap\", \"wgaim\"))"
},
{
"objectID": "installing-asreml.html#github-packages",
"href": "installing-asreml.html#github-packages",
"title": "\nInstalling and Configuring R and Rstudio with ASReml-R\n",
"title": "Installing and Configuring R and Rstudio with ASReml-R",
"section": "GitHub packages",
"text": "GitHub packages\nSome packages are not available on CRAN. These are commonly available to install via GitHub, but occasionally require a local installation.\nTo install packages from GitHub, you will first require the remotes package:\n\nif(!require(remotes)) install.packages(\"remotes\")\n\nOnce this is installed, you can install packages from GitHub with just the knowledge of the owner and repository names as in the following example:\n\nremotes::install_github(\"biometryhub/weathervane\")\n\nThe package in this example is called weathervane. It exists in a repository with the owner “biometryhub”. You can see this on the GitHub page here: https://github.com/biometryhub/weathervane.\nThe command above will download and install the package directly from GitHub, and may prompt you to update old packages that are already installed."
},
{
"objectID": "installing-asreml.html#other-packages",
"href": "installing-asreml.html#other-packages",
"title": "\nInstalling and Configuring R and Rstudio with ASReml-R\n",
"title": "Installing and Configuring R and Rstudio with ASReml-R",
"section": "Other packages",
"text": "Other packages\nSome packages are not available on CRAN or GitHub, and must be installed via an alternative method. One example of this is the ASExtras package, which adds additional functionality to asreml. To install this you will need to:\n\nDownload the relevant package file for your Operating System and version of R. In the ASExtras example, the package website has the appropriate links for the files: https://mmade.org/asextras4/\nOnce you have downloaded the file, you need to select it for installation. If using Rstudio, you can use the “Install” button in the Packages tab, and change the option in the top box (“Install from:”) to “Package Archive File (.zip, .tar.gx)”. This will cause a window to pop up to allow you to select the file you just downloaded.\nAlternatively you can use the command below, substituting the appropriate file path to the .zip or .tar.gz file.\n\n\ninstall.packages(\"path/to/package.zip\", repos = NULL) # Windows version\ninstall.packages(\"path/to/package.tar.gz\", repos = NULL) # macOS/Linux version\n\nThis should now proceed just like a regular package installation, though you may need to install additional dependency packages of the package you just installed."
}
Expand Down
14 changes: 6 additions & 8 deletions installing-asreml.Rmd → installing-asreml.qmd
View file
Original file line number Diff line number Diff line change
@@ -1,18 +1,16 @@
---
title: "<center>Installing and Configuring R and Rstudio with ASReml-R</center>"
title: Installing and Configuring R and Rstudio with ASReml-R
pagetitle: Installing ASReml-R
author:
- <center>Biometry Hub, University of Adelaide<center>
- <center>[email protected]<center>
date: "<center>Last updated: `r format(Sys.Date(), format='%B %Y')`</center>"
- Biometry Hub, University of Adelaide
- [email protected]
date: today
date-format: "MMMM YYYY"
toc: true
output:
html_document:
toc: yes
toc_float: yes
highlight: textmate
pdf_document:
fig_caption: yes
toc: yes
highlight: tango
linkcolor: blue
urlcolor: blue
Expand Down

0 comments on commit f569e73

Please sign in to comment.