Improve README #32
Improve README #32
Conversation
README.md
Outdated
| ## Features | ||
|
|
||
| 1. **VCF File Processing:** | ||
| - The project includes modules for reading and parsing VCF files, extracting relevant genomic information. |
There was a problem hiding this comment.
Not sure if you had a vision in mind for this, right now our VCF processing is limited and specific to 1000G and is really just calling bcftools. Let me know.
There was a problem hiding this comment.
Please suggest re-phrase, but don't get down to the level of specific dataset or tools
There was a problem hiding this comment.
did a small change, I think the modules was the only part that needed changing
CONTRIBUTING.md
Outdated
| @@ -10,8 +10,8 @@ Thank you for considering contributing to our Python project! By contributing, y | |||
|
|
|||
| ```bash | |||
| git clone https://github.com/ohsu-comp-bio/vrs-python-testing | |||
| python3 -m venv venv ; source venv/bin/activate | |||
| pip install -r requirements.txt | |||
| python3.10 -m venv venv; source venv/bin/activate | |||
There was a problem hiding this comment.
We shouldn't need to overspecify 3.10
We should be running on >=3.10
README.md
Outdated
| ## Features | ||
|
|
||
| 1. **VCF File Processing:** | ||
| - The project includes modules for reading and parsing VCF files, extracting relevant genomic information. |
There was a problem hiding this comment.
Please suggest re-phrase, but don't get down to the level of specific dataset or tools
|
|
||
| **CLI** | ||
|
|
||
| ```bash |
There was a problem hiding this comment.
Lets update this based on testing.
quinnwai
force-pushed
the
feature/improve-readme
branch
from
07429fe
to
381cc07
Compare
quinnwai
force-pushed
the
feature/improve-readme
branch
from
4d84346
to
a10c6dc
Compare
Goal: Make sure setup and README reflects project
I rebased on
features/packagingjust so everything was up to date, so you can ignore the first 6 commits.Left some comments below on things that you had suggested in the README that I had questions about