OluwadareLab / Robin

1 stars 0 forks source link

Robin: An Advanced Tool for Comparative Loop Caller Result Analysis Leveraging Large Language Models


OluwadareLab, University of Colorado, Colorado Springs


Developers:

H. M. A. Mohit Chowdhury
Department of Computer Science
University of Colorado at Colorado Springs
Email: hchowdhu@uccs.edu

Mattie Fuller
Department of Computer Science
University of Colorado at Colorado Springs
Email: mfuller@uccs.edu

Corresponding:

Oluwatosin Oluwadare, PhD
Department of Computer Science
University of Colorado at Colorado Springs
(Secondary) Department of Biomedical Informatics
University of Colorado School of Medicine, Anschutz Medical Campus
Email: ooluwada@uccs.edu


Using Robin

all information about using Robin can be found here: http://biomlearn.uccs.edu/robinrd/tutorial.html


Runnning Robin

Robin can be run by using the provided docker compose file to launch the required docker containers and link their ports together for you.

docker compose start cmd

    docker compose up

Setup instructions

1) run git submodule update --recursive --remote to pull the included subrepo of HiGlass. 2) run npm clean-install from inside /src/components/visualizationTools/HiGlass to install HiGlasses dependancies. 3) run npm install from the root of the project (IE: folder with package.json) to install robin's dependancies.

Developer Documentation

General Documentation The Developer readme meant to document anything a new developer looking to maintain the project might need to know.
Component Documentation. Robin uses React StyleGuidist for component documentation and isolated component development.
Full Documentation. Generated from in code comments using typeDoc
The Component documentation contains all documentation for react components in the site, whereas the full documentation contains the auto generated documenation for all code in the project.
Additional markdown files are placed throughout the project in any folder where its contents may need clarification.