For this analysis (and coding in general) you will need to ensure you computer has a few things installed.

This will depend on your operating system and of course what interfaces you intend to use.

The documentation below is largely from Software Carpentry

Bash

The Bash Shell Bash is a commonly-used shell that gives you the power to do simple tasks more quickly.

Windows

Video Tutorial

  1. Download the Git for Windows installer.
  2. Run the installer and follow the steps bellow:
    1. Click on “Next”.
    2. Click on “Next”.
    3. Keep “Use Git from the Windows Command Prompt” selected and click on “Next”. If you forgot to do this programs that you need for the workshop will not work properly. If this happens rerun the installer and select the appropriate option.
    4. Click on “Next”.
    5. Keep “Checkout Windows-style, commit Unix-style line endings” selected and click on “Next”.
    6. Keep “Use Windows’ default console window” selected and click on “Next”.
    7. Click on “Install”.
    8. Click on “Finish”.
  3. If your “HOME” environment variable is not set (or you don’t know what this is):
    1. Open command prompt (Open Start Menu then type cmd and press [Enter])
    2. Type the following line into the command prompt window exactly as shown: setx HOME "%USERPROFILE%"
    3. Press [Enter], you should see 1SUCCESS: Specified value was saved.1
    4. Quit command prompt by typing exit then pressing [Enter]

This will provide you with both Git and Bash in the Git Bash program.

macOS

The default shell in all versions of macOS is Bash, so no need to install anything. You access Bash from the Terminal (found in /Applications/Utilities). See the Git installation video tutorial for an example on how to open the Terminal. You may want to keep Terminal in your dock for this workshop.


Git

Git is a version control system that lets you track who made changes to what when and has options for easily updating a shared or public version of your code on github.com. You will need a supported web browser (current versions of Chrome, Firefox or Safari, or Internet Explorer version 9 or above).

You will need an account at github.com for parts of the Git lesson. Basic GitHub accounts are free. We encourage you to create a GitHub account if you don’t have one already. Please consider what personal information you’d like to reveal. For example, you may want to review these instructions for keeping your email address private provided at GitHub.

Windows

Git should be installed on your computer as part of your Bash install (described above).

macOS

Video Tutorial For OS X 10.9 and higher, install Git for Mac by downloading and running the most recent “mavericks” installer from [this list]. After installing Git, there will not be anything in your /Applications folder, as Git is a command line program. For older versions of OS X (10.5-10.8) use the most recent available installer labelled “snow-leopard” available here.


Text Editor

When you’re writing code, it’s nice to have a text editor that is optimized for writing code, with features like automatic color-coding of key words. The default text editor on macOS and Linux is usually set to Vim, which is not famous for being intuitive. if you accidentally find yourself stuck in it, try typing the escape key, followed by :q! (colon, lower-case ‘q’, exclamation mark), then hitting Return to return to the shell.

Windows

Video Tutorial nano is a basic editor and the default that instructors use in the workshop. To install it, download the Software Carpentry Windows installer and double click on the file to run it. This installer requires an active internet connection.

Others editors that you can use are Notepad++, atom or Sublime Text. Be aware that you must add its installation directory to your system path. Please ask your instructor to help you do this.

macOS

nano is a basic editor and the default that instructors use in the workshop. See the Git installation video tutorial for an example on how to open nano. It should be pre-installed.

Others editors that you can use are Text Wrangler, atom or Sublime Text.


R

R is a programming language that is especially powerful for data exploration, visualization, and statistical analysis. To interact with R, we use RStudio.

Windows

Video Tutorial Install R by downloading and running this .exe file from CRAN. Also, please install the RStudio IDE. Note that if you have separate user and admin accounts, you should run the installers as administrator (right-click on .exe file and select “Run as administrator” instead of double-clicking). Otherwise problems may occur later, for example when installing R packages.

macOS

Video Tutorial Install R by downloading and running this .pkg file from CRAN. Also, please install the RStudio IDE.

Recommendation R is much more than statistics, and making graphs, it is a never-ending tool that is constantly being updated. Before we know it R will be able to cook your dinner and go to the shops too! But for now check out its great range of features for project management. It can talk all types of coding languages, and is useful to keep track of exactly what you are doing. You can even make your own webpage to help keep track of all that code and information, just like I am doing here! Some links to get you started: - R markdown - R shiny - R project for statistical computing - Project management with RStudio - R bookdown


Anaconda - Jupyter notebook (optional)

Although Jupyter notebook is not neccessary to run the NGS analysis outlined in this webpage it is a very useful, easy to use and well documented tool. I have played around with both and I always seem to go back to RStudio + command line (MacOS), but take your pick!

It combines all the tools above - such as Bash and R and includes a lot more. It is great if you are interested in python scripting. In addition it also gives you an anaconda environment which is a common requirement for some program (in this case QIIME2). It can serve as a ‘one stop shop’ in respect to being able to execute Bash and Python code, it allows easy install of dependencies (which is partiuclarly prevelent in Python language) it allows you to use markdown with ease, and integrates with github. RStudio and a number of other programs are also integrates into the anaconda environment.

For download of Anconda - Jupyter notebook click here.

A good (but perhaps long) video tutorial is available here.


Some other things you’ll need

USEARCH

See the usearch getting started page for information on installing and excuting commands using USEARCH.

QIIME2

The QIIME2 native install page will get you started for your QIIME analysis.

RStudio packages

The pages on RStudio, starting with Phyloseq Intro will walk you through any additional RStudio packages you will need.



Vector and Waterborne Pathogens Research Group. 2018. S Egan.