Skip to content
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

Update MAG class to MetaBin #67

Merged
merged 6 commits into from
May 14, 2020
Merged

Conversation

evanroyrees
Copy link
Collaborator

  • resolves [dev branch] Issues with autometa/common/mag.py #53
  • 🎨 Update to pass coverage filepath in user.py for get_binning rather than pd.DataFrame.
  • 📝 Add docstrings to methods and class.
  • 🎨🔥 Remove split_nucleotides method.
  • 🎨 Update get_binning function to handle coverages as filepath not pd.DataFrame.
  • 🎨 Change mag.py to metabin.py.
  • 🐎 fixed from PR-fixes-#54 Metagenome #66. Add cache functionality to time-consuming property methods.
  • 📝 Add COMBAK comment for checkpointing. Return to this when implemented in utilities.py.

* resolves issue-KwanLab#54
* 📝 Update docstrings missing for functions.
* 🐎 Add cache for properties reading assembly sequences.
* 🎨 Add Entrypoint functionality for incorporation to packaging/distribution.
* 🎨🐛 Update main() to handle updated functions.
* 📝 Add docstrings to methods and class
* 🎨🔥 Remove split_nucleotides method.
* 🎨 Update get_binning function to handle coverages as filepath not pd.DataFrame
* 🎨 Change mag.py to metabin.py
* 🐎 fixed from PR-KwanLab#66. Add cache functionality to time-consuming property methods.
* 📝 Add COMBAK comment for checkpointing. Return to this when implemented in utilities.py
@evanroyrees evanroyrees added documentation Improvements or additions to documentation enhancement New feature or request labels May 5, 2020
@evanroyrees evanroyrees added this to the Aim 0: Release 2.0 milestone May 5, 2020
@evanroyrees evanroyrees self-assigned this May 5, 2020
@evanroyrees evanroyrees linked an issue May 5, 2020 that may be closed by this pull request
12 tasks
f'Num. Nucl. ORFs: {self.nnucls:,}\n'
f'Num. Prot. ORFs: {self.nprots:,}\n'
f'Size: {self.size:,}bp / {self.totalsize:,}bp ({self.size_pct:4.2f}% of total metagenome)\n'
f'Mean GC content: {self.length_weighted_gc:4.2f}%\n'
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

The print output should probably explicitly say the GC content is length-weighted.

Copy link
Collaborator

@jason-c-kwan jason-c-kwan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think I just had one comment. I like the docstrings for properties in metabin.py. For consistency it would be good to have them in metagenome.py, either as part of this PR or PR #66.

@evanroyrees
Copy link
Collaborator Author

I recommend addressing #66 prior to this.

@jason-c-kwan
Copy link
Collaborator

The comment above about the describe output of the MetaBin class still needs to be addressed.

@evanroyrees
Copy link
Collaborator Author

This was addressed in commit 3033b0d

The changes should be reflected in the files changed section. You may need to refresh your page. Otherwise, the code is linked below:

https://github.com/WiscEvan/Autometa/blob/3033b0d1f526ddb4c07919fccc7545fdc711f905/autometa/common/metabin.py#L319-L345

Copy link
Collaborator

@jason-c-kwan jason-c-kwan left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think this looks fine to merge now

@jason-c-kwan jason-c-kwan merged commit 587c873 into KwanLab:dev May 14, 2020
@evanroyrees evanroyrees deleted the issue-#53 branch May 14, 2020 22:58
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation enhancement New feature or request
Projects
None yet
Development

Successfully merging this pull request may close these issues.

[dev branch] Issues with autometa/common/mag.py
2 participants