-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
- Loading branch information
jslit
authored and
jslit
committed
Feb 7, 2023
1 parent
f277c40
commit c64a6a2
Showing
37 changed files
with
80 additions
and
28 deletions.
There are no files selected for viewing
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,5 +1,56 @@ | ||
# bamscope | ||
<img | ||
src="example.png" | ||
alt="Alt text" | ||
style="display: inline-block; margin: 0 auto; max-width: 300px"> | ||
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://github.com/jslfree080/bamscope/blob/main/LICENSE) | ||
|
||
<img alt="demonstration" src="https://github.com/jslfree080/jslfree080/blob/main/example2.png" width=550> | ||
|
||
A command line tool (in Kotlin/JVM) for visualizing BAM alignments. | ||
|
||
## Prerequisites | ||
|
||
Bamscope requires **Java 11** or later versions to build and run. | ||
|
||
Also, [samtools](https://github.com/samtools/samtools) should be pre-installed to support accessing file formats such as BAM and FASTA. | ||
|
||
## Building | ||
|
||
* Clone the repo: | ||
``` | ||
git clone https://github.com/jslfree080/bamscope.git | ||
cd bamscope/ | ||
``` | ||
|
||
* Build an executable Bamscope jar with all dependencies packaged: | ||
``` | ||
./gradlew build | ||
``` | ||
|
||
## Usage | ||
|
||
### Command line | ||
|
||
The resulting jar will be in `build/libs`. | ||
|
||
``` | ||
Usage: java -jar build/libs/bamscope.jar <chrPos> <bamPath> [options] | ||
Parameters: | ||
<chrPos> Input chromosomal position. ex) (chr)N:XXXXXXXX | ||
<bamPath> Path to an indexed bam file. ex) path/to/x.bam | ||
Options: | ||
-f, --format=<format> File format of an output image. default) png | ||
-h, --help Show this help message and exit. | ||
-o, --outPath=<outPath> Path to an output image. default) . | ||
-r, --refPath=<refPath> Path to a reference fasta. ex) path/to/x.fasta | ||
-s, --sPath=<sPath> Path to the samtools. ex) /usr/local/bin/samtools | ||
-w, --width=<width> Width of start to interest position. default) 50 | ||
``` | ||
|
||
* Example usage: | ||
``` | ||
java -jar build/libs/bamscope.jar 18:53254446 ~/Downloads/x.bam -r ~/Downloads/x.fasta -o ~/Desktop/ | ||
``` | ||
|
||
## License | ||
|
||
Code and documentation released under the [MIT license](https://github.com/jslfree080/bamscope/blob/master/LICENSE). |
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file modified
BIN
+0 Bytes
(100%)
build/classes/kotlin/main/com/jslfree080/cli/BAMScopeCommand.class
Binary file not shown.
Binary file not shown.
Binary file not shown.
File renamed without changes.
Binary file not shown.
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
build/kotlin/compileTestKotlin/local-state/build-history.bin
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
build/kotlin/kaptGenerateStubsKotlin/cacheable/last-build.bin
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
build/kotlin/kaptGenerateStubsKotlin/local-state/build-history.bin
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
build/kotlin/kaptGenerateStubsTestKotlin/cacheable/last-build.bin
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
build/kotlin/kaptGenerateStubsTestKotlin/local-state/build-history.bin
Binary file not shown.
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
4 changes: 2 additions & 2 deletions
4
build/test-results/test/TEST-com.jslfree080.process.CheckWidthAgainTest.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<testsuite name="com.jslfree080.process.CheckWidthAgainTest" tests="1" skipped="0" failures="0" errors="0" timestamp="2023-02-06T10:13:54" hostname="jungsoo080ui-MacBookPro.local" time="0.029"> | ||
<testsuite name="com.jslfree080.process.CheckWidthAgainTest" tests="1" skipped="0" failures="0" errors="0" timestamp="2023-02-07T02:57:56" hostname="jungsoo080ui-MacBookPro.local" time="0.025"> | ||
<properties/> | ||
<testcase name="testExpDecayResult()" classname="com.jslfree080.process.CheckWidthAgainTest" time="0.029"/> | ||
<testcase name="testExpDecayResult()" classname="com.jslfree080.process.CheckWidthAgainTest" time="0.025"/> | ||
<system-out><![CDATA[]]></system-out> | ||
<system-err><![CDATA[]]></system-err> | ||
</testsuite> |
4 changes: 2 additions & 2 deletions
4
build/test-results/test/TEST-com.jslfree080.process.CheckWidthFirstTest.xml
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,7 +1,7 @@ | ||
<?xml version="1.0" encoding="UTF-8"?> | ||
<testsuite name="com.jslfree080.process.CheckWidthFirstTest" tests="1" skipped="0" failures="0" errors="0" timestamp="2023-02-06T10:13:54" hostname="jungsoo080ui-MacBookPro.local" time="0.002"> | ||
<testsuite name="com.jslfree080.process.CheckWidthFirstTest" tests="1" skipped="0" failures="0" errors="0" timestamp="2023-02-07T02:57:56" hostname="jungsoo080ui-MacBookPro.local" time="0.001"> | ||
<properties/> | ||
<testcase name="testFixedResult()" classname="com.jslfree080.process.CheckWidthFirstTest" time="0.002"/> | ||
<testcase name="testFixedResult()" classname="com.jslfree080.process.CheckWidthFirstTest" time="0.001"/> | ||
<system-out><![CDATA[]]></system-out> | ||
<system-err><![CDATA[]]></system-err> | ||
</testsuite> |
Binary file not shown.
Binary file not shown.
Binary file modified
BIN
+0 Bytes
(100%)
build/tmp/kapt3/incrementalData/main/com/jslfree080/cli/BAMScopeCommand.class
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Binary file not shown.
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters