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

Added component to display funding information to tool form and update tool footer view #16477

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

Conversation

hechth
Copy link

@hechth hechth commented Jul 28, 2023

This PR introduces new Vue components to display funding information on the tool form and adds the parsing logic for this to the backend. I have also updated the PersonView and OrganizationView with a popup and new buttons which replace the pure icon buttons which were not really obviously buttons in the first place and the popover dialog with a proper popup (see picture 2). The Galaxy tool XSD schema is extended with the required types and I slightly refactored the Python class representation, introducing Thing as a base class.

This PR also sets the maxOccurence for creator and funding to 1, as they hold arrays for Persons, Organization or Grant respectively.

This feature is useful as it allows people to specify where they received their funding to develop the Galaxy tool and it highlights organizations or projects investing money into Galaxy tool development. This also helps developers of tools find out which previous projects funded Galaxy tool development, improving transparency. It also improves the visibility of infrastructure work and funding.

The component does not support displaying the funder and sponsor fields at this point, which can be a person or organization.
The testing so far only includes a single unit test for the backend to test the parsing logic. No frontend tests are included so far.

Thanks to @ElectronicBlueberry, @bgruening and @itisAliRH for the help!
funding_snippet

image

This also includes the creator tag in the order for the tool.xml file to stop the linter complaints.

Closes galaxy-iuc/standards#75

How to test the changes?

(Select all options that apply)

  • I've included appropriate automated tests.
  • This is a refactoring of components with existing test coverage.

License

  • I agree to license these and all my past contributions to the core galaxy codebase under the MIT license.

Copy link
Contributor

@bernt-matthias bernt-matthias left a comment

Choose a reason for hiding this comment

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

Certainly a good idea!

For the display it seems that the info shown in the tool form seems to be the same as the detailed description when clicking on it. My first thought was that I would prefer a display as in papers, i.e. just name, identifier (and link).

lib/galaxy/schema/schema.py Show resolved Hide resolved
lib/galaxy/tool_util/parser/interface.py Show resolved Hide resolved
lib/galaxy/tool_util/parser/xml.py Outdated Show resolved Hide resolved
@hechth
Copy link
Author

hechth commented Aug 2, 2023

Certainly a good idea!

For the display it seems that the info shown in the tool form seems to be the same as the detailed description when clicking on it. My first thought was that I would prefer a display as in papers, i.e. just name, identifier (and link).

We can also put the description only in the popup and have only the short version at the bottom if that is overall preferred @mvdbeek @ElectronicBlueberry @itisAliRH @bernt-matthias @bgruening

@bgruening
Copy link
Member

I would vote for the short version in the form and the longer version in the popup.

@mvdbeek mvdbeek modified the milestones: 23.2, 24.0 Dec 19, 2023
@jdavcs jdavcs modified the milestones: 24.0, 24.1 Feb 26, 2024
@mvdbeek mvdbeek removed this from the 24.1 milestone May 14, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Introduce creator tag in xml_order in top level tool.xml file
5 participants