-
Notifications
You must be signed in to change notification settings - Fork 13
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
base: dev
Are you sure you want to change the base?
Conversation
liannette
commented
Oct 16, 2024
- 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
… file, improve docstrings
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 |
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! |
@CunliangGeng It's ready for review :) I just can not request a review explicitly, because I have only read permission for the repository. |
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.
Let's check the code step by step, and first thing to check is about code format and style:
- Please check the errors in the static typing, and correct the incorrect typings. You could use
mypy
to check them locally before committing. - 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.
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 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.
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.
This PR needs changes before approval ;-)
I just looked through your comments, they are quite helpful, thanks! |
Two more suggestions:
|
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.
I integrated the requested changes, except the ones in the unresolved conversations. Can you take a look at my replies there?