Skip to content

Cooltools insulation #3634

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

Open
wants to merge 31 commits into
base: master
Choose a base branch
from
Open

Conversation

nservant
Copy link
Contributor

@nservant nservant commented Jul 12, 2023

new modules cooltools/insulation

  • This comment contains a description of changes (with reason).
  • If you've fixed a bug or added code that should be tested, add tests!
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • If necessary, include test data in your PR.
  • Remove all TODO statements.
  • Emit the versions.yml file.
  • Follow the naming conventions.
  • Follow the parameters requirements.
  • Follow the input/output options guidelines.
  • Add a resource label
  • Use BioConda and BioContainers if possible to fulfil software requirements.
  • Ensure that the test works with either Docker / Singularity. Conda CI tests can be quite flaky:
    • PROFILE=docker pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
    • PROFILE=singularity pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware
    • PROFILE=conda pytest --tag <MODULE> --symlink --keep-workflow-wd --git-aware

@nservant nservant added Ready for Review new module Adding a new module labels Aug 10, 2023
Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

Presumably the .tsv file varies every time you run it, else it would have a md5sum in the .yml, but you should be able to use contains to check for a word in it.

@SPPearce
Copy link
Contributor

Bumping the PR, it looks like it is virtually ready, can we get it finished off?

@edmundmiller edmundmiller requested a review from a team as a code owner October 19, 2023 16:26
@SPPearce SPPearce dismissed their stale review June 25, 2024 08:33

Stale

@SPPearce
Copy link
Contributor

@nservant, I've updated this to nf-test. I have also swapped to just a cooltools container rather than the mulled one; if this is an issue then seqera containers will be the answer once we have that fully up and running.

I think the only thing outstanding is that the test-data is using a github link, which we would like to avoid. So we'd rather use the cooler test data that already exists in the git repo (perhaps put through another tool as a setup requirement), or add some new test data. I tried swapping to the test_merge_cool file, but that gave me an error.

@famosab
Copy link
Contributor

famosab commented Feb 11, 2025

Bump :)

@SPPearce
Copy link
Contributor

Bump :)

To be honest, I'm tempted to just merge this here with an external github link.

@famosab
Copy link
Contributor

famosab commented Mar 7, 2025

Bump :)

To be honest, I'm tempted to just merge this here with an external github link.

The meta.yml linting also needs to be fixed so :/

@SPPearce
Copy link
Contributor

SPPearce commented Mar 7, 2025

Bump :)

To be honest, I'm tempted to just merge this here with an external github link.

The meta.yml linting also needs to be fixed so :/

Eh, that is doable.

@luisas luisas added awaiting-changes will be closed after 30 days awaiting-feedback will be closed after 30 days labels Mar 11, 2025
@nservant
Copy link
Contributor Author

Hi guys, @SPPearce

cooler insulation usually requires a normalized (balanced) contact maps, which is not the case of the toy.symm.upper.2.cool dataset.
To fix it, you could run ;

cooltools insulation toy.symm.upper.2.cool --clr-weight-name '' --ignore-diags 1

Otherwise, we can add an additional normalized dataset in test ? The latest will make more sense to really test the tool, but that's not mandatory.
N

@famosab
Copy link
Contributor

famosab commented Apr 29, 2025

@nservant If its small test data I would be in favor of adding it to our own test-datasets github if there is no other suitable data available over there

@SPPearce
Copy link
Contributor

SPPearce commented May 7, 2025

Hi guys, @SPPearce

cooler insulation usually requires a normalized (balanced) contact maps, which is not the case of the toy.symm.upper.2.cool dataset. To fix it, you could run ;

cooltools insulation toy.symm.upper.2.cool --clr-weight-name '' --ignore-diags 1

Otherwise, we can add an additional normalized dataset in test ? The latest will make more sense to really test the tool, but that's not mandatory. N

So we can use the same tool to make a correct input for this one? We could just do that inside the nf-test then.

Copy link
Contributor

@SPPearce SPPearce left a comment

Choose a reason for hiding this comment

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

Can you please add ontologies to the meta.yml file (https://nf-co.re/blog/2025/modules-ontology)

@Thibault-Poinsignon
Copy link

Thibault-Poinsignon commented Jun 6, 2025

Hello @SPPearce, I updated the edam ontologies and did the other corrections. I couldn't find an ontology for .cool files, does it exist?

@SPPearce
Copy link
Contributor

SPPearce commented Jun 6, 2025

Hello @SPPearce, I updated the edam ontologies and did the other corrections. I couldn't find an ontology for .cool files, does it exist?

Absolutely no idea, I don't know anything about the ontologies, some other people care more than me about this. The way to add things seems to be detailed here .
I'm not going to block the PR without this.

Co-authored-by: Simon Pearce <[email protected]>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
awaiting-changes will be closed after 30 days awaiting-feedback will be closed after 30 days new module Adding a new module
Projects
Development

Successfully merging this pull request may close these issues.

7 participants