aki2274 / KOnezumi-AID

MIT License
3 stars 0 forks source link

Update readme #96

Closed aki2274 closed 3 months ago

aki2274 commented 3 months ago

Readmeをアップデートしました. また,ほかの部分の変更も少し行っています. 大きな変更点としては,遺伝子シンボルがデータにない場合の対応です. 合わせてご確認いただければ幸いです.

aki2274 commented 3 months ago

こちら対応いたしました.

akikuno commented 3 months ago

マイナーな点ですが、

Required Packages(Don't need if you install via conda)Required Packages (Not needed if installed via conda)

にしてくださいー Do not needですと意味が強すぎる印象を受けました👀

aki2274 commented 3 months ago

コメントありがとうございます.修正しました. 合わせてスペルミスも修正しました.

akikuno commented 3 months ago

ありがとうございます!

最後?にIf search by a transcript name, you can get more information about gRNAs.(gene symbolとtranscript nameによる出力の違い)について、理由があると良いと思います。

ユーザーは基本的にはgene symbolを入力しますが、上記の記載ですと、transcript nameを入力したほうが良いように感じます。

gene symbolを入力するとCritical exonを狙える利点がある(だから、gene symbolでもいいよ!)といった記載があるとユーザーは安心かと思います。

aki2274 commented 3 months ago

箇条書きで区別するようにしました.この表記の仕方で問題ないでしょうか.

akikuno commented 3 months ago

早速ありがとうございます!

more information about the gRNAsのinformationを具体的に明記するとよいでしょう。 例えば、gRNAの数であれば、more numbers of gRNAsと明記してください。複数ある場合には、箇条書きにしていただけますと幸いです。

aki2274 commented 3 months ago

箇条書きにて追加しました.mor informationの内容自体がわかりにくいですが,こちらは出力を整理した際に修正したいと思います.

akikuno commented 3 months ago

ありがとうございます。

そうですね、個人的にはgene symbolで得られたgRNAの情報について詳細がほしいところです。

このPRではすでに十分に改定で来ていると思いますので、more informationについては別のIssueにしましょうか。

aki2274 commented 3 months ago

そうですね、個人的にはgene symbolで得られたgRNAの情報について詳細がほしいところです。

同感です.出力の修正はやや優先度の高いタスクですかね.