# BamShare の使い方

## BamShare とは
BAM や変異抽出結果エクセルをマックに置きサーバにすることで、複数のマックや Windows からファイルへアクセスすることが出来ます。
エクセルについては WEB 上で開き IGV と連携することでデータチェックに利用することも出来ます。


変異をクリックだけで IGV で変異の詳細を確認することが出来ます。

---
## 起動方法
**アプリをダブルクリック！**

アプリを起動するとマック上で WEB サーバが起動し Safari が開きます。
エラーページが表示された場合はリロードしてみてください。
初回起動時は docker からダウンロードされサーバ起動に時間がかかります。我慢してください。(笑)

---
## 共有したいファイルの保存場所
共有ファイルの保存場所はデスクトップの kazusa または kazusa と言う名前を付けた USB ディスクとなります。両方が存在した場合はデスクトップが優先されます。

デスクトップに kazusa フォルダを作成します。
kazusa の中に analysis フォルダを作成します。
analysis フォルダの中に bam フォルダと excel フォルダを作成します。

bam フォルダの中に共有したい *.bam と *.bai ファイルをコピーしてください。
excel フォルダの中に共有したい *.xlsx ファイルをコピーしてください。


追加したあとはブラウザをリロードしてください。

SSD では容量も限られていますので USB 接続のメモリや HDD が良いかもしれません。
USB 接続のストレージの場合はドライブ名を kazusa として上の画像と同じフォルダ構成としてください。
デスクトップに kazusa フォルダが有るとそちらが優先されてしまうため削除かリネームをしてください。

---
## 他のパソコンからの接続
起動すると Safari でトップページが開きます。
初期パスワードは以下となっています。

user: curry
password: Ch!kin65

他のパソコンから接続したい場合には Safari のアドレスバーに表示されている URL をコピーするか上部のコピーアイコンをクリックしてください。
**この URL は他のパソコンからも開くことが出来る**ので共有したい人達に教えてあげてください。

---
## BAM一覧
kazusa - analysis - bam フォルダにある *.bam の一覧が表示されます。
コピーアイコンをクリックすることでダウンロード用の URL をコピーすることができます。
ダウンロードアイコンをクリックすると bam と bai ファイルをダウンロードすることができます。

対応するエクセルが excel フォルダにある場合はステータスに Excel アイコンが表示されます。


コピーアイコンでコピーされた URL は IGV から開くことが出来ます。
IGV の File -> Load From URL に入力することで他のパソコンからアプリを実行しているマック上の BAM を開くことが出来ます。
同一ネットワーク上の方に「〜のデータを IGV で見て欲しいので URL を IGV で開いてください」のように使うと便利かなと。

BamShare は**インターネット上に公開しているわけではありません**ので外部組織の方に教えても接続することは出来ませんのでご注意ください。
あくまで組織内など同一ネットワークに限られます。
逆に同一ネットワークの人からは見えてしまいますので見られたくない BAM は置かないようにしてください。


---
## Excel一覧
kazusa - analysis - excel フォルダにある *.xlsx の一覧が表示されます。
コピーアイコンをクリックすることでダウンロード用の URL をコピーすることができます。
ダウンロードアイコンをクリックすると bam と bai ファイルをダウンロードすることができます。


対応する BAM が bam フォルダにある場合はステータスに BAM アイコンが表示されます。

エクセルを添付しなくても URL をコピーしてメール等で連絡をすれば組織内の同一ネットワーク上であればダウンロードすることが出来ます。

エクセルファイルをクリックすることで変異の詳細を表示することが出来ます。

---
## 変異一覧
ついでのつもりがメインなのかもしれない機能...。
表示可能なエクセルはかずさ遺伝子検査室のエクセルとカレー部アプリのエクセルのみとなります。
対応する BAM がある場合には上部に表示されます。IGV起動後にBAM表示をクリックすることで連携します。


### IGV との連携
遺伝子名とゲノム位置をクリックすると IGV と連携して表示されます。

### 他サイトへのリンク
RefSeq ID と dbSNP については両サイトへのリンクを付けてみました。

### ソート
カラム名をクリックすることでソートされます。

### クイックフィルター
左上のフォームに入力することでエクセル全体に対してのフィルター実行されます。

### カラムごとのフィルター
カラム名の右側にカーソルを合わせるとハンバーガーメニュー(「三」みたいなの)が表示されます。
文字列での絞り込みや数値による絞り込みを行うことが出来ます。

例えばクイックフィルターで Pathogenic とすると Likely Pathogenic も表示されます。
Clinical Significance カラムで Equals を選び Pathogenic で絞り込むことで Pathogenic のみを表示することが出来ます。

---
## BAM とエクセルの対応について
ファイル名をドットで区切った左側で対応を取っています。
**ControlNA12828**.hg38.SureCall.bam

上の場合は ControlNA12828.xlsx や COntrolNA12828.mod.xlsx が該当します。
ControlNA12828test.xlsx は該当しません。ドット区切りです。

---
## 他のパソコンから BAM やエクセルの転送
Mac の共有設定でディスクを共有することで他の Mac や Windows からファイルの転送を行うことが出来ます。
接続の際に Mac のログインユーザで認証されるためアプリを実行するユーザとパスワードの認証情報を共有することになります。個人ではなく共有できるユーザを作成することをオススメいたします。


環境設定の一般の共有のファイル共有をポチッとオンに変更するだけ。
Mac であれば Finder の移動のサーバへ接続を選んで smb://IP-ADDRESS で接続できます。
Windows であればエクスプローラーのアドレスバーで \\\IP-ADDRESS で接続出来ます。

アプリで起動する WEB ページのログイン認証とはことなりますのでご注意ください。
WEB ページへログインする際の認証情報は下の手順で変更することが出来ます。

---
## ログインユーザーとパスワードの変更
analysis フォルダに init.txt を作成し下の内容を書き込んでください。

[system]
user = naan
password = MutnCury

マックでテキストファイルを作成し保存するには「テキストエディット」を使います。
テキストエディットを起動し上をコピペし user と password を希望の文字列に書き換えてください。
**user, password とも半角英数字なのでご注意を。**

フォーマットメニューから標準テキストにするを選択。
保存の際に場所を analysis でファイル名を init.txt としてください。
rtf 形式(リッチテキスト)では認識されませんのでご注意ください。txt と rtf はカレーとハヤシライスくらい異なります。


---
## アプリの終了方法
右下のキャンセルはでは終了しないため左上の☓で終了となります。
しかしながらアプリを終了しても共有のために起動した docker コンテナは終了しません。
docker の Dashboard を開いて bamshare を終了させてください。
面倒くさかったらマック再起動です(笑)

まずは　docker の Dashboard を開いて
<img src="https://hackmd.io/_uploads/H1Zb5M51R.png" width=300px></img>

containers から bamshare を停止します

---
## ついでに docker について
docker ですがイメージとしては docker サーバに置かれた CD-ROM をダウンロードして、そのアプリケーションを起動しているようなイメージです。
ダウンロードした CD-ROM を image 、動いているアプリケーションを container と呼びます。
上の操作ではアプリで起動した container を終了しています。
このような動作のため初回起動時にはダウンロードが発生するため起動に時間がかかってしまいます。

docker は必要な image を自動でダウンロードして起動してくれるので非常に便利ですが自動で削除してくれないためディスクを圧迫する場合があります。
docker の容量が大きくなってきたら Dashboard の images から不要なものを削除できます。


どれを削除してよいかわからなかったら全部削除しても大丈夫です。
必要なものは自動で再ダウンロードされるのでご安心ください。削除後の初回起動に時間がかかっちゃうけど...。

---
## サポート
ご不明な点や機能追加のご希望はカレー部までご連絡ください。

---
## ライセンス
配布自由ですがカレー部員以外にはサポートがありません。すんません。

---
## 最後に
たくさんのご意見をくださったカレー部岐阜支部のみなさんに感謝。