nexus icon indicating copy to clipboard operation
nexus copied to clipboard

Report Plugin: Support ability to capture and present Tool that generated report

Open samuel-kerrien opened this issue 1 year ago • 0 comments

Description

The scientists would like to capture how the assets were generated in the report. To do so, they will need to capture :

  • where the code is located (link to git repo with hash/tag),
  • how they ran the code to generate the asset. There might be multiple tools described with their own git link and description.

Acceptance Criteria

  • The user should be able to easily link his code (in git) to the report
  • The user should be able to describe the process that generated the code to enable reproducibility
  • The users should be able to update both the link and the description
  • The report view should present the tools (git link and desc.)
  • We should support the ability to have more than one SoftwareAgent attached to the Report.

TODO @loris-olivier create a prototype with several tools TODO @loris-olivier add visual assets

Mockups

Two tools registered in the report image.png

Report creation: capture tool(s) that generated report (default view) image.png

Report creation: capture tool(s) that generated report (adding one tool) image.png

Report creation: capture tool(s) that generated report (tool added) image.png

samuel-kerrien avatar Aug 12 '22 13:08 samuel-kerrien