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

add methods to export results in tabular format #280

Open
wants to merge 25 commits into
base: dev
Choose a base branch
from

Conversation

liannette
Copy link

  • add method to nplinker class for exporting links, as well as genomic and metabolomic data
  • add test for generating the tabular data for the links

@CunliangGeng
Copy link
Member

CunliangGeng commented Oct 17, 2024

Please assign me to review it when it's ready ;-) If you're still working on that, it's better to change it to a draft PR

@liannette
Copy link
Author

I thought I was finished, but I realized that it still needs a bit of work. I will assign you as soon as I'm happy with it!

@liannette liannette marked this pull request as draft October 17, 2024 13:29
@liannette liannette marked this pull request as ready for review October 18, 2024 15:43
@liannette
Copy link
Author

@CunliangGeng It's ready for review :) I just can not request a review explicitly, because I have only read permission for the repository.

@CunliangGeng CunliangGeng self-requested a review October 22, 2024 07:28
Copy link
Member

@CunliangGeng CunliangGeng left a comment

Choose a reason for hiding this comment

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

Let's check the code step by step, and first thing to check is about code format and style:

  1. Please check the errors in the static typing, and correct the incorrect typings. You could use mypy to check them locally before committing.
  2. It is not explicitly mentioned, but we do follow some rules for the order of methods/functions in a class/file. The order of methods/functions are:
  • __init__ method
  • other magic methods, e.g. __str__
  • property methods (using @property)
  • regular methods, class methods (using @classmethod), static methods (using @staticmethod)
  • private methods (_func )
  • deprecated methods (using @deprecated)

For the same level of methods, e.g. regular methods, it's recommended to order them in alphabetical order.

Please check the new methods/functions you added and put them in the right place.

Copy link
Member

@CunliangGeng CunliangGeng left a comment

Choose a reason for hiding this comment

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

Please check the comments in each file.

Last time I mentioned that for the same level of methods, e.g. regular methods, it's recommended to order them in alphabetical order. Well, I forgot to mention that it's better to cluster and order the methods based on their purposes, e.g. it's intuitive to put the input/read/load methods before the output/write/save/dump methods regardless of their names.

Also, please do not change the order of existing methods in this PR, it's better to do it in an independent PR.

@CunliangGeng CunliangGeng self-requested a review October 25, 2024 09:42
Copy link
Member

@CunliangGeng CunliangGeng left a comment

Choose a reason for hiding this comment

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

This PR needs changes before approval ;-)

@liannette
Copy link
Author

I just looked through your comments, they are quite helpful, thanks!

@CunliangGeng
Copy link
Member

Two more suggestions:

  1. You could use Github Desktop to mange your local commits (e.g. reorder and squash/combine them) with ease. This practise could make the commits more organised, which will make it easier to understand your changes and facilitate the review process.
  2. The PR basically could be split to 2 or more smaller PRs to make each PR more atomic and faster to review. For example, the changes to bgc.py is independent, which could be done in another PR. You don't have to split this PR now. Next time, when there are independent/irrelevant changes, please consider putting them in another PR.

Copy link
Author

@liannette liannette left a comment

Choose a reason for hiding this comment

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

I integrated the requested changes, except the ones in the unresolved conversations. Can you take a look at my replies there?

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
Status: In progress
Development

Successfully merging this pull request may close these issues.

2 participants