Jagannathan Lab Tools

This package contains numerous templates and tools to make life at the Jagannathan Lab happier and more efficient! Check out our release presentation

This package allows the Project Name, PI, and Project Analyst to be stored in a ProjData.dcf file to be easily retrieved and used in headers and reports.

Example of header snippet using Project Data:

snippet header
	###########################################
	# Project: `r jagtools::ProjectName()`
	# Author: `r jagtools::ProjectAnalyst()`
	# Date: `r paste(format(Sys.Date(), '%m/%d/%Y'))`
	# #########################################

There is a JAG LAB Tools project template (requires RStudio version 1.1) that sets up the project folder using the JAG LAB Tools template with ReadMe files in each folder and an option to set up a git repository. You can also save project metadata.

This package also contains functions for reading excel files with colour columns and the Table1 function.

Please feel free to file an issue request if you encounter errors or would like to request new features.

Prerequisites

Before you begin, ensure you have met the following requirements:

Tool	How to install?	How to learn?
Windows only: Chocolately	Visit chocolatey.org.	Chocolately installs software for you, it is installed and called from the terminal/command prompt. To open the comand prompt, press Windows+X and then click on “Command Prompt” or “Command Prompt (Admin).”
OS X only: Homebrew	Visit brew.sh.	Homebrew installs software for you. It is installed and called from the terminal/command prompt. To open the terminal press Command + Space to open Spotlight and then type “Terminal” and double click on the top search result.
R	Windows: Use Chocolately (from the terminal). choco install -y r.project OS X: Use Homebrew. brew install r	Read: R for Data Science
Rstudio	Windows: Use Chocolately (from the terminal). choco install -y r.studio OS X: Use Homebrew (from the terminal). brew cask install rstudio	Skim the cheatsheet
rmarkdown	Within Rstudio, type into the R-console: install.packages("rmarkdown")	Read the cheatsheet. Skim R Markdown: The Definitive Guide
Git	Windows: Use Chocolately (from the terminal). choco install -y git OS X: Git gets installed with Homebrew. Nothing to do.	Read Part IV Git fundamentals And skim the rest of Happy Git and Gitub for the useR.
GitHub	Create an account on: github.com And apply for Student/Researcher Benefits	Read Part II Connect Git, GitHub, RStudio And III Early GitHub Wins.
Make	Windows: Use chocolately. choco install -y make OS X: Make is preinstalled on OS X. Nothing to do.	Read Minimal Make

Installing jagtools

To install jagtools, follow these steps in R:

if(!require(devtools)){
    install.packages("devtools")
}

devtools::install_github('akirosingh/Jagannathantools')

Using jagtools

To use jagtools, follow these steps:

<usage_example>

Add run commands and examples you think users will find useful. Provide an options reference for bonus points!

Contributing to jagtools

To contribute to jagtools, follow these steps:

1. Fork this repository.
2. Create a branch: git checkout -b <branch_name>.
3. Make your changes and commit them: git commit -m '<commit_message>'
4. Push to the original branch: git push origin jagtools/<location>
5. Create the pull request.

Alternatively see the GitHub documentation on creating a pull request.

Contributors

Thanks to the following people who have contributed to this project:

emmanuella-coder 🎨

Adam Kirosingh 💻 🤔 📖

kdantz8 🤔

KattriavdP 🤔 📓

Contact

If you want to contact me you can reach me at adamsk@stanford.edu.

License

This project uses the following license: MIT License.