Skip to content

Commit 0f79a6d

Browse files
Update README.md
1 parent 38f6aef commit 0f79a6d

File tree

1 file changed

+14
-4
lines changed

1 file changed

+14
-4
lines changed

README.md

Lines changed: 14 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,12 @@ NOTE: These are the version the program was created on, future versions of these
5656
5. If you want a CAM model generated for the input sequence run:
5757
> EnhancerMatcher.py two_similar_enhancers.fa sequences.fa --cam
5858
59-
6. In the output folder, the generated CAM is called sequence_CAM.pdf
59+
6. If you want a colorblind friendly CAM model generated for the input sequence run:
60+
> EnhancerMatcher.py two_similar_enhancers.fa sequences.fa --cam --colorblind
6061
61-
Opening it will show a heatmap for the given sequence, the dark red regions show the main area that influenced EnhancerMatcher's final decision. Please read the main paper for more details.
62+
7. In the output folder, the generated CAM is called sequence_CAM.pdf
63+
64+
Opening it will show a heatmap for the given sequence, the dark red regions show the main area that influenced EnhancerMatcher's final decision. Please read the main paper for more details. Provided is a colorblind option where in this case the yellow brigher spots are main interest spots.
6265

6366
If you wish to run EnhancerMatcher via the jupyter notebook:
6467

@@ -74,9 +77,13 @@ If you wish to run EnhancerMatcher via the jupyter notebook:
7477

7578
Set this parameter to output_cam_pdf = True
7679

77-
4. If you want to change the output directory locate and edit output_dir with your output directory.
80+
4. If you want a colorblind friendly CAM model generated then locate the second cell and locate colorblind_friendly.
81+
82+
Set this parameter to colorblind_friendly = True
7883

79-
5. Once you edit the parameters, run the entire notebook and the outputs will be generated in the output directory.
84+
5. If you want to change the output directory locate and edit output_dir with your output directory.
85+
86+
6. Once you edit the parameters, run the entire notebook and the outputs will be generated in the output directory.
8087

8188
## To Run our Tests:
8289
1. Look inside the Test_Input folder, inside are two fasta files:
@@ -91,6 +98,9 @@ If you wish to run EnhancerMatcher via the jupyter notebook:
9198
If you want to generate a CAM output for each sequence run:
9299
> python EnhancerMatcher.py Test_Input/input1.fasta Test_Input/input2.fasta --cam
93100
101+
If you want to generate a colorblind friendly CAM output for each sequence run:
102+
> python EnhancerMatcher.py Test_Input/input1.fasta Test_Input/input2.fasta --cam --colorblind
103+
94104
3. Inside the Output folder will be the results and CAM models for each given sequence.
95105

96106
4. If you want to use the jupyter notebook then open EnhancerMatcher.ipynb

0 commit comments

Comments
 (0)