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 metadata import section #6

Merged
merged 18 commits into from
Jun 17, 2020
Merged

Add metadata import section #6

merged 18 commits into from
Jun 17, 2020

Conversation

pwalczysko
Copy link
Member

Adding metadata import section.

Possibly the order could be reversed, and possibly a new section showing how to create a quick and easy, simple bulkmap config could come in.

cc @francesw @manics @jburel

docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
Copy link
Member

@manics manics left a comment

Choose a reason for hiding this comment

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

It's not clear to me who this guide is targetted at:

  • People using the outreach server during a workshop given by us?
  • People using their own OMERO server?

docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
@pwalczysko
Copy link
Member Author

pwalczysko commented Jun 4, 2020

@manics

It's not clear to me who this guide is targetted at:

People using the outreach server during a workshop given by us?
People using their own OMERO server?

Both. We need simply both. And we do not have the margin to produce two parallel lines.
If you could specify the main unclear points (for potential users who are not within our workshop) ?

@manics
Copy link
Member

manics commented Jun 4, 2020

I think you need to tell people how to obtain and import idr0021, otherwise they can't follow the guide on their own server. Alternatively you could write your own bulkmap-config.yml for a smaller dataset?

For example, https://omero-guides.readthedocs.io/en/latest/introduction/docs/annotate.html says

The data used are from the siRNAi-HeLa folder available at https://downloads.openmicroscopy.org/images/DV/siRNAi-HeLa/

Perhaps you could annotate those images instead?

docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
pwalczysko and others added 3 commits June 4, 2020 13:53
This corresponds to simple-annotation.csv

For example, run:

omero metadata populate --context bulkmap --cfg simple-annotation-bulkmap-config.yml Dataset:2066

To delete the map-annotations added by the above config file run:

omero metadata populate --context deletemap --cfg simple-annotation-bulkmap-config.yml Dataset:2066
@manics
Copy link
Member

manics commented Jun 4, 2020

pwalczysko#1 adds a simple-annotation-bulkmap-config.yml file corresponding to simple-annotation.csv

pwalczysko and others added 4 commits June 5, 2020 14:15
Add example simple-annotation-bulkmap-config.yml
Co-authored-by: Mark Carroll <[email protected]>
Co-authored-by: Mark Carroll <[email protected]>
Co-authored-by: Mark Carroll <[email protected]>
@pwalczysko
Copy link
Member Author

@manics thank you for the simple-bulkmap-config.yml

After reading the description in the commit and the comments in the file itself, I have two questions.

Can we have the KVPs listed under the "Default namespace" organized in the "Others" header in the webclient ? What governs this ? @francesw was meaning that this might be the indentations of the blocks such as d9acb71#diff-e2d81d8cdbf9ac42c679d54ca6b0af06R51 (in her example these blocks had indentations, in yours d9acb71#diff-e2d81d8cdbf9ac42c679d54ca6b0af06R51 they are unindented. Is that the crucial point which decides about the "Others" header in webclient later ?

We do not have all the mapr categories defined in the outreach servers, and, somehow, the mapr on these servers does not seem to work for these newly added KVPs using the simple... csv and bulkmap files. Only the "old" annotated idr0021 seem to be handled correctly by mapr on outreach.

This (and also the fact that mapr is complex, needs an extra install, we do not have a walkthrough for it, etc.) leads me to another question:

Can I have a nice header like Phenotypes for my KVP group, but not have a mapr category defined ? (as you see, I would like to offer a step 1. no-mapr-yet and step 2. mapr-if-you-want approach).

@pwalczysko
Copy link
Member Author

@manics Is this jinja magic d9acb71#diff-e2d81d8cdbf9ac42c679d54ca6b0af06R107 logic encoded in the omero metadata plugin ? This is a nice feature.

@pwalczysko
Copy link
Member Author

Addressed the comments. Now we have two options, one using the IDR data, one using the siRNAi-HeLa data, which are easier to get.

@jburel
Copy link
Member

jburel commented Jun 10, 2020

maybe create a folder with the csv, yml files and not mix them with the .rst doc file

docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
docs/metadata.rst Outdated Show resolved Hide resolved
Copy link
Member

@manics manics left a comment

Choose a reason for hiding this comment

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

Looks fine to me

scripts/simple-annotation-bulkmap-config.yml Outdated Show resolved Hide resolved
@jburel jburel merged commit bcdaa27 into ome:master Jun 17, 2020
@pwalczysko pwalczysko deleted the metadata branch June 17, 2020 15:37
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

5 participants