life-science-protocols / protbot

Protein quantification automation using R
https://life-science-protocols.github.io/protbot/
Other
0 stars 0 forks source link

Design draft of report for protein quantification #2

Open ramiromagno opened 10 months ago

ramiromagno commented 10 months ago

Hi @lsilvam:

Could you make a design draft of the report we intent to create to describe the protein quantification? Something drawn with pen and paper would suffice.

We can then work on a Quarto template (.qmd): https://blog.devgenius.io/how-to-create-dynamic-pdf-reports-with-r-quarto-b9b5217b888c. This quarto template would harbor the text, tables and plots of the report.

Then we can use the function quarto_render() to generate a report. This will be generated dynamically for a given dataset.

We can have several quarto templates, we can place them in inst/templates, and then have a function from the protbot package, e.g. create_report() that takes several arguments, including the original data, the calibration curve data, and some other tweaking options of the report generation.

lsilvam commented 9 months ago

Hi @ramiromagno

here is a draft of a basic structure we could follow (considering A4 format, yet unrestricted HTML page):

drawing_protbot_issue2

Here is a brief description:

  1. Header: for project and experiment labels;
  2. Experimental design: a brief description of the experiment;
  3. Placeholder for the calibration curve plot. I left the whole width to have space to plot one or more plots, or if suits better a wider plot;
  4. Placeholder to print out a final table with results of the quantification;
  5. Notes/Obs: a brief description of the results and conclusions;
  6. Footer: page numbering

What do you say?

We can have several quarto templates

Yes, it makes sense to me to follow that implementation with a create_report() function. I have a doubt though. From the user's point of view can we stop when all is filled except points 2 and 5 of the report?