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

Possibility to download the project information #720

Open
oquendoM opened this issue Jul 22, 2024 · 5 comments
Open

Possibility to download the project information #720

oquendoM opened this issue Jul 22, 2024 · 5 comments
Assignees
Labels
enhancement New feature or request needs clarification Unclear issue where more information needs to be provided by the issuer triage An issue that is in discussion to be either scheduled for implepmentation or denied UI/UX

Comments

@oquendoM
Copy link

Hello!

Is your feature request related to a problem? Please describe.
In some of the downstream analysis reports we need to provide project information, like project title, PI and contact at QBiC. At the moment there is no possibility to download this data from the Data Manager in a table format.

Describe the solution you'd like
I would like to have a feature like the User Database - Download Project Information that we currently have in the qPortal.

Describe alternatives you've considered
Manually copy and paste the information on tables, however this is very cumbersome.

@KochTobi KochTobi added the enhancement New feature or request label Jul 23, 2024
@sven1103 sven1103 added the triage An issue that is in discussion to be either scheduled for implepmentation or denied label Aug 5, 2024
@sven1103
Copy link
Contributor

sven1103 commented Aug 12, 2024

Dear @oquendoM

so what you are looking for is a way to download a project information summary?

Could you list the properties you would need for it to be contained?

Why do you favor a tabular format over e.g. a simple text file or YAML?

Where would you expect this export to be available? In the project list or from within the project? @Shraddha0903 is also pinged, since it will affect the UX.

@sven1103 sven1103 added UI/UX needs clarification Unclear issue where more information needs to be provided by the issuer labels Aug 12, 2024
@oquendoM
Copy link
Author

Hi @sven1103

Yes, we would like to have a way to automatically download the project information. Tagging @qbicStefanC here also.

Based on what is showed in the Project Summary page we would like:

  • Project ID
  • Title
  • Objective
  • Project collaborators

The pipeline uses a .tsv file as input. But from my test it also work with .txt if the arguments are separated by tab.

If the download is from within the Data Manager, I would expect the button to be next to "Edit" in the Project Summary page.

@sven1103
Copy link
Contributor

Hi @oquendoM ,

Can you tell us more about the pipeline use case? I would favor (in order for standardization and interoperability) to implement standards more in the data manager, meaning an export e.g. in the domain standard format ISA (https://isa-specs.readthedocs.io/en/latest/isamodel.html#).

Of course an proprietary format export is always an option, when a suiting standard is not available.

Best, Sven

@Shraddha0903 Shraddha0903 self-assigned this Aug 28, 2024
@sven1103
Copy link
Contributor

After some personal discussion with @oquendoM and others, we settle on a JSON-based export format where the application provides the schema for it.

Looking into existing standards and notations, I am suggesting to start with a JSON-LD export of a https://schema.org/ResearchProject object and decorate it e.g. for project manager, project contact and principal investigator. For the latter we can use https://schema.org/ContactPoint, which provides the properties we have.

@sven1103
Copy link
Contributor

BTW, there is no need for JSON-LD libaries in Java, lets just annotate our export object classes properly, to adhere to JSON-LD:
https://json-ld.org/

Here is an example how to build it with jackson, no need to include yet another third party library:

https://stackoverflow.com/questions/50738973/jackson-jsonld-nested-objects

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request needs clarification Unclear issue where more information needs to be provided by the issuer triage An issue that is in discussion to be either scheduled for implepmentation or denied UI/UX
Projects
Status: Todo
Development

No branches or pull requests

4 participants