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

bioformats2raw module #7518

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Conversation

CaroAMN
Copy link
Contributor

@CaroAMN CaroAMN commented Feb 26, 2025

PR checklist

Closes #7422

  • This comment contains a description of changes (with reason).
  • If you've added a new tool - have you followed the module conventions in the contribution docs
  • 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.

new modules: bioformats2raw

I used now a seqera container: community.wave.seqera.io/library/bioformats2raw:0.9.4--3eec45888b3759e5

  • not sure if this is correct in the module main.nf
  • nf-test passes with docker

The tool is not in conda-forge or bioconda but from the ome channel ( open microscopy environment ) and i get errors from linting:

The environment.yml of the module bioformats2raw is not valid: 'ome' is not one of ['bioconda', 'conda-forge'].

@camlloyd camlloyd self-requested a review March 2, 2025 11:04
Copy link
Contributor

@camlloyd camlloyd left a comment

Choose a reason for hiding this comment

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

Looks good! A few comments though.

In theory Wave allows any conda channel, but the linter disagrees 🧐.

- image:
type: file
description: bioformats supported image file format
pattern: "*.{tif,tiff,svs,mrxs}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Are there suitable ontologies you could add here?

See https://nf-co.re/blog/2025/modules-ontology


cat <<-END_VERSIONS > versions.yml
"${task.process}":
bioformats2raw: \$(bioformats2raw --version |& sed '1!d ; s/bioformats2raw //')
Copy link
Contributor

Choose a reason for hiding this comment

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

Could you make the version start with a numeric character, rather than Version =?

I think it would also be helpful to emit the Bio-Formats and
NGFF specification versions here.

- "*ome.zarr":
type: directory
description: OME-Zarr fileset for image data storage. Specification can be found at https://ngff.openmicroscopy.org/latest/#storage-format
pattern: "*{ome.zarr}"
Copy link
Contributor

Choose a reason for hiding this comment

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

Similarly are there ontologies you could add here?

def prefix = task.ext.prefix ?: "${meta.id}"

"""
touch ${prefix}.ome.zarr
Copy link
Contributor

Choose a reason for hiding this comment

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

Should this be a file, or a directory?

def prefix = task.ext.prefix ?: "${meta.id}"

"""
bioformats2raw \\
Copy link
Contributor

Choose a reason for hiding this comment

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

I see you used label 'process_single' above.

Out of interest did you try using --max-workers $task.cpus here?

description: Java application to convert image file formats, including .mrxs, to an intermediate Zarr structure compatible with the OME-NGFF specification.
keywords:
- zarr
- OME-NGFF
Copy link
Contributor

Choose a reason for hiding this comment

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

This needs to be all lower case.

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.

new module: BIOFORMATS2RAW
2 participants