README.md

In hyginn/shi: Multiple Sequence Alignment Handling and Inspection

shi

multiple S-equence alignment H-andling and I-nspection

Also: shì (視) to inspect, to view

This is a BCB330H1/BCB430H1 project in bioinformatics at the University of Toronto. If you are not enrolled in this course, this code is unlikely to be useful to you.

This package follows the structure and process suggested by Hadley Wickham in:

R Packages http://r-pkgs.had.co.nz/

Some useful keyboard shortcuts for package authoring:

• Build and Reload Package: Cmd + Shift + B
• Update Documentation: Cmd + Shift + D or devtools::document()
• Test Package: Cmd + Shift + T
• Check Package: Cmd + Shift + E or devtools::check()

Reading the vignettes.

• Build and install the package and vignette: devtools::install(build_vignettes = TRUE)
• List the vignettes: browseVignettes("shi")
• Read a specific vignette: vignette("Extensive-Guide-To-Shi")

Rebase your branch and Check your branch before every push. DO NOT PUSH CODE that does not pass without error, warnings and notes. We are running Travis CI on GitHub and your code can't be merged if it fails. To merge, push your branch to GitHub and create a pull request. Then tap someone to review your code and merge it.

Load the package (outside of this project) with: devtools::install_github("hyginn/shi")

hyginn/shi documentation built on May 6, 2019, 9:53 a.m.