AlexsLemonade / scpca-nf

scpca-nf is the Nextflow workflow for processing Single-cell Pediatric Cancer Atlas Portal data
BSD 3-Clause "New" or "Revised" License
12 stars 2 forks source link

Add sample metadata tables to reports #769

Closed allyhawkins closed 2 months ago

allyhawkins commented 2 months ago

Closes #765

This PR adds a function to create a sample metadata table to report_functions.Rmd and then uses that function in both the main QC report and cell type report to create the sample metadata table. The table is shown for any non-multiplexed samples. Otherwise, we have a nice little blue box that says the metadata will not be displayed since the sample is not demultiplexed. I took the wording from the merge report where we also don't show sample metadata.

The table is formatted in the same way we have our other tables and I was able to successfully add links for the ontology IDs 🎉. I also accounted for missing ontology IDs and only provide a link if an ID was provided.

In the main report I adjusted a few headers to account for adding in this table.

Questions for reviewers:

Also, I've been seeing the following error for this table, but I'm not sure how to fix it. The table is still printed, but if we can remove this message that's probably best?

Warning message: In yaml::yaml.load(yaml, handlers = knit_params_handlers(evaluate = evaluate), : an error occurred when handling type 'r'; using default handler

Here's a zip with copies of the updated QC and cell type reports for a multiplexed and non-multiplexed sample: updated_reports.zip

jashapiro commented 2 months ago

Also, I've been seeing the following error for this table, but I'm not sure how to fix it. The table is still printed, but if we can remove this message that's probably best?

Warning message: In yaml::yaml.load(yaml, handlers = knit_params_handlers(evaluate = evaluate), : an error occurred when handling type 'r'; using default handler

Can you narrow down when you are seeing this warning? I don't see it in any of the reports you sent, so is it only with some samples?

allyhawkins commented 2 months ago

Can you narrow down when you are seeing this warning? I don't see it in any of the reports you sent, so is it only with some samples?

It doesn't print out in the reports, but only when I run the chunk that has the new metadata table locally or when I render the report it prints out in R.

allyhawkins commented 2 months ago

I don't have great ideas about the warning you are seeing, but you might be able to narrow it down by turning on debugging with debug(print_sample_metadata) and running the chunk. That should allow you to find exactly where the warning is coming from.

I think it might be something with my Rstudio? I get the warning for any chunk that I run, but the chunk runs successfully. I found a similar issue here. I could be way off, but I also ran the code in the console and don't see any warnings. So it's definitely something with the notebook itself. I also don't think it's a huge deal since rendering it works as expected?

I also incorporated your edits and removed the Ontobee link so this should be ready for another look.