You are viewing an old version of this page. View the current version.

Compare with Current View Page History

« Previous Version 8 Next »

Install Spectre from Github


Spectre version

To see if you have Spectre installed, you can open RStudio and look under the 'packages' tab. The version will be listed in the right hand column. Hit the  button to refresh the package list if you need. If you have the latest version installed, R won't install it again. If you have an older version, the R will install the latest version. If you wish, you can check the Spectre Home Page for the latest version. 

If you are updating Spectre, we advise deleting the previous installation to ensure a clean update.

remove.packages('Spectre')

.

Install Devtools

In R, install and load the 'devtools' package. The devtools package has a number of dependencies (packages that it needs to use) that it will automatically install when you install 'devtools' – this might take some time.

## Install (if not already installed)
if(!require('devtools')) {install.packages('devtools')}

.

Install Spectre

Subsequently, use the 'install_github' function to install and load the Spectre package. By default this will load the 'master' branch, which is the same as the latest stable release version (listed at https://immunedynamics.github.io/spectre). To install a specific release version, see https://cran.r-project.org/web/packages/githubinstall/vignettes/githubinstall.html.

## Install Spectre
library('devtools')
install_github("immunedynamics/spectre")

.

Updating

If you are updating Spectre (rather than installing for the first time), we recommend re-starting RStudio at this point. 

.

Confirm or decline updates

During installation, you may see a message like the following. You can update all the packages if you wish, but if you are unsure, or using multiple packages in other contexts, it might be wise to wait until you have time to update everything and test your scripts afterwards.

These packages have more recent versions available.
Which would you like to update?

1: All                               
2: CRAN packages only                
3: None                              
4: rlang    (0.4.1  -> 0.4.2 ) [CRAN]
5: digest   (0.6.22 -> 0.6.23) [CRAN]
6: roxygen2 (7.0.0  -> 7.0.1 ) [CRAN]

Enter one or more numbers, or an empty line to skip updates:
# Type '1' and press enter to update all packages, or '3' and press enter for no updates
3

.


Installation troubleshooting

Occasionally during installation, you may run into errors, such as the one below relating to 'flowCore'. Check out our installation troubleshooting page for help.

Error in library("flowCore") : there is no package called ‘flowCore’
Error: unable to load R code in package ‘Spectre’
Execution halted

.

Check libraries (packages)

Once the packages have been installed, you can check the libraries (packages) by running the 'package.check()' function. If installation of any specific package was not successful, see our installation troubleshooting page for help.

## Check if all required packages have been installed
Spectre::package.check()

If all packages were successfully installed:

All packages successfully installed

If all packages were NOT successfully installed:

'dplyr is required but not installed'


Load libraries (packages)

You can then load the required packages using the 'package.load()' function.

## Load all required packages
Spectre::package.load()

Troubleshooting

Package installations can fail due to a number of reasons, including R version incompatibilities (for example, Spectre v0.1 will not work in R v3.3.0), or package incompatibilities. If you are having problems installing Spectre, please see our installation troubleshooting page or submit an issue on the Spectre Github repository. Alternatively, you can install Spectre using one of our self-contained docker images.

  • No labels