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

The future of summaries #391

Open
cleme opened this issue Apr 28, 2022 · 4 comments
Open

The future of summaries #391

cleme opened this issue Apr 28, 2022 · 4 comments
Labels
enhancement Summaries Relating to summary generation
Milestone

Comments

@cleme
Copy link
Member

cleme commented Apr 28, 2022

Is your feature request related to a problem? Please describe.
Summaries take a significant amount of effort to generate, and the code is getting increasingly complex to keep functional and to maintain. We already had a release (0.7.0.1) to address these issues, but unsuccessfully as we later found out. Currently summaries do not work in production, and the final PDF has to be manually generated.

Describe the solution you'd like

  • Continue using current approach: not ideal, as it means we cannot fully automate analysis. Code will be hard to maintain and modify in the future if we want to include additional analyses in results (which we want)
  • Redo the notebooks to simplify dependencies: convert all code to R so we only depend on libraries that can be directly managed under R.
  • Basic HTML solution: generate an index.html file that links to individual plots with some text describing result.
  • Full visualization through web interface: similar to current Q2 solution.
@cleme cleme added enhancement Summaries Relating to summary generation labels Apr 28, 2022
@cleme cleme added this to the 0.9.0 milestone Apr 28, 2022
@adamcantor22
Copy link
Member

Since we did succeed in getting summaries to work in production, do we want to close this issue? Or do we still want to consider this down the line?

@cleme
Copy link
Member Author

cleme commented May 5, 2022

Let's keep open. The PDF is nice, but I think at some point in the future we'll want to re-evaluate what is the best way to summarize results for users.

@adamcantor22 adamcantor22 modified the milestones: 0.9.0, 0.11.0 Oct 12, 2022
@adamcantor22
Copy link
Member

Consider embedding Qiime2 viewer into a new MMEDS tab so results can be accessed without a summary.

@cleme
Copy link
Member Author

cleme commented May 30, 2023

Consider how adding tools to MMEDS impacts summary generation. The current implementation is not automated and likely not generalizable (see #457 also)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
enhancement Summaries Relating to summary generation
Projects
None yet
Development

No branches or pull requests

2 participants