2. `bstr` Installation

For more detailed installation instructions, usage examples, or to check for updated versions of bstr, please visit the bstr website: http://brainsuite.org/bstr/.

2.1. Prerequisites

Ensure BrainSuite is installed on your computer: http://brainsuite.org/download
Ensure R is installed on your computer: https://cran.r-project.org/
Install RStudio: https://www.rstudio.com/products/rstudio/#Desktop
Windows only: Install Rtools, available at https://cran.r-project.org/bin/windows/Rtools/

2.2. Steps for installation

Open RStudio and enter the following commands to install bstr version 0.5.2.
You can pull directly from the BrainSuite server (Online Installation), or you can download the bstr_0.5.2.tar.gz file directly and install from your downloads folder.
Do not untar or uncompress bstr_0.5.2.tar.gz – the installer needs it in this format.

2.3. Online Installation

install.packages('devtools')
devtools::install_url('https://brainsuite.org/wp-content/uploads/2024/09/bstr_0.5.2.tar.gz')

2.4. macOS or Linux - Install from folder

Replace /path/to/ with the path to the folder where you downloaded bstr.

install.packages('devtools')
devtools::install_local('/path/to/bstr_0.5.2.tar.gz')

2.5. Windows - Install from folder

Note that on Windows, you will need to use double backslashes () in the path because backslash is an escape character. You can also replace the backslashes with forward slashes. Replace C:\\path\\to\\ or C:/path/to/ with the path to the folder where you downloaded bstr.

install.packages('devtools')
devtools::install_local('C:\\path\\to\\bstr_0.5.2.tar.gz')

or

install.packages('devtools')
devtools::install_local('C:/path/to/bstr_0.5.2.tar.gz')

2.6. Check your installation

Type

library(bstr)

then

get_brainsuite_install_path()

This should display the BrainSuite installation path.

2. bstr Installation