-
Notifications
You must be signed in to change notification settings - Fork 0
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Please suggest re-phrase, but don't get down to the level of specific dataset or tools
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
did a small change, I think the modules was the only part that needed changing
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Generally looks good, however commits now in development still show up here.
Few minor comments. Let's hold off until we test.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
We shouldn't need to overspecify 3.10
We should be running on >=3.10
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
updated
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
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.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Lets update this based on testing.
07429fe
to
381cc07
Compare
4d84346
to
a10c6dc
Compare
Goal: Make sure setup and README reflects project
I rebased on
features/packaging
just 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