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 a "Generate Report" button to generate a results report. #314

Open
Tracked by #195
donaldcampbelljr opened this issue Jun 5, 2024 · 6 comments
Open
Tracked by #195
Assignees
Labels
enhancement New feature or request UI/UX
Milestone

Comments

@donaldcampbelljr
Copy link

donaldcampbelljr commented Jun 5, 2024

We want to be able to generate a results report via button for results that have been reported to PEPHub via Pipestat and are defined via a pipestat output schema.

@donaldcampbelljr donaldcampbelljr transferred this issue from pepkit/pipestat Jun 5, 2024
@donaldcampbelljr donaldcampbelljr changed the title By pushing files to s3, such as images, we could then generate the results report on the server and have PEPHub serve it to the users via a "Generate Report" button. Add a "Generate Report" button to generate a results report. Jun 5, 2024
@donaldcampbelljr donaldcampbelljr added enhancement New feature or request UI/UX labels Jun 5, 2024
@nsheff nsheff added this to the v0.12.x milestone Jun 25, 2024
@nsheff nsheff mentioned this issue Jun 25, 2024
7 tasks
@nleroy917 nleroy917 self-assigned this Jun 25, 2024
@nleroy917
Copy link
Member

How might this work? Is there some configuration in pipestat that does this? I.e., does this need to be a new endpoint or can it be done in-browser. Is there an example output?

@donaldcampbelljr
Copy link
Author

We will have a PEP that contains results reported via pipestat and the PEP must be associated with a pipestat output schema.

From this information, a report can be generated. Originally, we discussed using the pipestat summarize function (which generates a local html report) but we decided that this report generation via PEPHub should be a new implementation.

A current example PEP where I pushed results via pipestat: https://pephub.databio.org/donaldcampbelljr/pipestat_demo?tag=default
However, currently, PEPHub does not know which output schema I used for this reporting!

For any reported statistics, this should be reasonably easy. However, if we wish to show images, then Pipestat will need to push images to s3 and the reported image path will need to point to the s3 location of the images. This is discussed a bit more in this pipestat issue: pepkit/pipestat#195

For an example of the kind of html report pipestat summarize generates: https://pepatac.databio.org/en/latest/files/examples/gold/gold_summary.html

@nleroy917
Copy link
Member

Pipestat will need to push images to s3 and the reported image path will need to point to the s3 location of the images

So, this doesn't have much of an implication to PEPhub, right?

@donaldcampbelljr
Copy link
Author

Pipestat will need to push images to s3 and the reported image path will need to point to the s3 location of the images

So, this doesn't have much of an implication to PEPhub, right?

Where will the report generation code live? That code needs to display an image from an s3 path (if an image is a reported result to s3).

@nleroy917
Copy link
Member

  • convert the Jinja HTML templates to JSX.
  • For piptestat compatible PEPS, a button that opens new window with the correct output.

@donaldcampbelljr
Copy link
Author

Per discussion, this could be a React application that lives within Pipestat.
A hash router must be used so that the application can run locally.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement New feature or request UI/UX
Projects
None yet
Development

No branches or pull requests

3 participants