Skip to content

Commit a1bcb4c

Browse files
authored
Update README.md
- Updated conda channel to bioconda - Added build times - Added test case list instructions
1 parent caeefd6 commit a1bcb4c

File tree

1 file changed

+8
-2
lines changed

1 file changed

+8
-2
lines changed

README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ Current methods that determine MSI status using sequencing data compare the dist
1717

1818
### Installing with conda
1919
```
20-
conda install mimsi -c pytorch
20+
conda install mimsi -c bioconda
2121
evaluate_sample --version
2222
```
2323
*Note that the conda package requires python 3.6, 3.7, or 3.8*
@@ -37,7 +37,7 @@ cd mimsi # Root directory of the repository that includes the setup.py script.
3737
pip install .
3838
evaluate_sample --version
3939
```
40-
40+
On a local machine, build time for MiMSI via pip should be less than 2 minutes, depenent on download speed.
4141

4242
## Running a Full Analysis
4343

@@ -93,7 +93,13 @@ analyze --case-list /path/to/case_list.txt --microsatellites-list ./test/microsa
9393

9494
The NGS vectors will be saved in ```save-location``` just as in the single case example. Again, as in the single case example all results are printed to standard out and can be saved to disk by setting the optional ```--save``` flag. Using the```--save-format``` you can choose to save the final results as a numpy array or a .txt file (including summary statistics) or both. The default mode is to save as a .txt file.
9595

96+
A test case list is provided to test MiMSI funcationality, located in `tests` and can be run as follows:
9697

98+
```
99+
cd tests
100+
analyze -case-list test_case_list.txt --microsatellites-list ./microsatellites_impact_only.list --save-location ./ --model ../model/mi_msi_v0_4_0_200x_attn.model --use-attention --save
101+
```
102+
With BAM files under 20MB, this test should take a few seconds to complete and will assess the working status of the MiMSI package.
97103

98104
## Running Analysis Components Separately
99105

0 commit comments

Comments
 (0)