morinlab / GAMBLR

Set of standardized functions to operate with genomic data
https://morinlab.github.io/GAMBLR/
MIT License
3 stars 2 forks source link

Based on the description in the tutorial, what is the purpose of collate_results? #204

Closed rdmorin closed 1 year ago

rdmorin commented 1 year ago

We need to be more explicit in some of the examples in the tutorials. One I came across was collate_results. As someone who has never used that function, the description in the tutorial doesn't really give a sense of what this function is for. All the text after this sentence relates only to the various ways to run the function.

Another useful function for collecting all derived sample-level results from a variety of GAMBL pipelines is to call collate_results. 
mattssca commented 1 year ago

Thanks for reporting this. I can update the vignette to be more informative in regard to the purpose of this function.

mattssca commented 1 year ago

This has been addressed in this PR.