This R package encapsulates the material for the short course on Phylogenetic Comparative Analysis of Integrated Anatomical Traits.
The purpose of doing so is to leverage the R package installation mechanism for ensuring that all R dependencies needed for the course are installed and available, simply as a result of installing this package.
The material itself is in the form of vignettes written in RMarkdown. Users are encouraged to modify the code chunks and re-execute the vignettes as a means of exploring the material.
You can download the course material to your computer directly from Github as a Zip archive. Click the Download Zip link that appears under the Clone or Download, move the Zip archive to a directory of your choice, then unpack it.
You can then open the folder containing the material as a project in RStudio, and render (“knit”) and modify the vignette(s) (see vignette/
subdirectory).
The RPhenoscape vignette depends only on the RPhenoscape package, which can be installed directly from Github as per its documentation. (RPhenoscape has itself a number of recursive dependencies; installing the package will install those, too.)
The PARAMO vignette has a number of dependencies. These can be installed automatically by installing the workshop package, either from the command line (use R CMD build
, followed by R CMD INSTALL
), or from within RStudio using the install_github()
function in the remotes
package (which can be installed from CRAN using install.packages()
):
remotes::install_github("phenoscape/scate-shortcourse")
This command will likely trigger a (possibly long) list of packages that are required to be installed and upgraded, or suggested for upgrade, with a prompt for choosing how to select which packages to upgrade or install. Unless you happen to have installed an earlier version of RPhenoscape that fails to meet the required version, we recommend to use the option for installing and upgrading from CRAN only. (Typically, this will be option 2.)
Note that the above command will use the default options for build arguments, which will leave out building and installing the vignettes. Since the best use of the vignettes is to go through (and potentially modify) them within RStudio, this shouldn’t be an issue.
If your operating system is some flavor of Linux, many of the package dependencies that include compiled code will end up being installed from source. Some of these have dependencies external to R, and thus installing them from source will fail if these external dependencies are not pre-installed.
Currently, the following packages are required on top of a Ubuntu 18.04 / R 5.3.3 environment: - libmagick++-dev - libgmp-dev - libmpfr-dev - pandoc
Other base systems may require additional (or fewer) external packages.
SCATE is funded by the US National Science Foundation (NSF) as collaborative awards 1661456 (Duke University), 1661529 (Virginia Tech), 1661516 (University of South Dakota), and 1661356 (UNC Chapel Hill and RENCI) within the Advances in Biological Informatics (ABI) program.
To the extent possible under law, the SCATE Project Team has waived all copyright and related or neighboring rights to this work. See the CC Zero public domain waiver for details.
If you reuse or make derivatives of this work, we request that you cite or otherwise give proper credit to this work.