Skip to content

Template Repo for generating new JupyterReviewer Suites

License

Notifications You must be signed in to change notification settings

getzlab/AnnoMateTemplate

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

7 Commits
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

MyCustomReviewers

Suite of reviewers for reviewing <>.

MyCustomReviewers

Install

Activate or Set up Conda Environment

This is highly recommended to manage different dependencies required by different reviewers.

See Set up Conda Environment for details on how to download conda and configure an environment.

Install PurityReviewers

Clone

git clone git@github.com:<>/<MyCustomReviewer>.git 

# or in an existing repo
git submodule add git@github.com:<>/<MyCustomReviewer>.git 

Install

cd MyCustomReviewer
conda activate <your_env>
pip install -e .

Basic usage

See <MyCustomReviewer>/example_notebooks for basic examples and demos of the purity reviewers.

See <MyCustomReviewer>/Reviewers to see available pre-built reviewer options.

See <MyCustomReviewer>/DataTypes to see pre-built data configurations for purity review.

Custom and advanced usage

See MyCustomReviewer/AppComponents for pre-built components and their customizable parameters, and additional utility functions.

For customizing annotations, adding new components, and other features, see Intro_to_AnnoMate Reviewers.ipynb.

For creating your own prebuilt reviewer, see Developer_AnnoMate_Tutorial.ipynb.