Create a report out of rco recommendation

[ColinFay]

I think it would be nifty to be able to create a report out of {rco} optimisers.

The idea would be to analyse the whole code and return some kind of markdown / bookdown that will list all the results from the optimisers, without changing the original code.

It might be useful to analyse your own code and learn what you could do better, but also it could be use in the industry to analyse the quality of code.

[jcrodriguez1989]

Hey @ColinFay , I really appreciate your suggestions/ideas.
I am going to propose rco for the Google Summer of Code 2020, so any idea it comes out of your mind would be great to get more things to work on.
Maybe we could get two GSoC proposals, one to continue developing optimizers, and another to improve usability.

Thanks!
Juan C

[saxenism]

Hey @ColinFay , we have decided to work on this functionality. We are of the opinion that a report right in the console of the user (in the Markdown format, so it can be copy-pasted) could be a better and probably smoother choice (as a user would typically run multiple iterations of the rco) rather than creating a Rmd document every time.
Also, the differences, between the original and optimized code can be viewed in the Shiny app of the rco.

So, we were hoping that you could let us know what exactly is your intention/wish with this functionality and does that critically require a separate Rmd or bookdown document?

Thanks and cheers _ / \ _

[ColinFay]

Hey,

I definitely think that would be nice to have that, yet (that's a personal preference) it won't be smoother to have it in the console: imho that's definitely harder to read than a rendered markdown.
But that probably depends on where you are working (RStudio or straight in the console).
As it is a simple markdown I'm not sure it would take a long time to compile.
With a markdown feature, it would also be nice to have a "continuous watch", that re-render the Markdown in RStudio viewer everytime a file is changed (in the way xaringan::infinite_moon_reader() does).

Also, I was hoping to have this as part of a CI/CD pipeline, so that the report is generated along code coverage, test reports...

Maybe it would be possible to have both? (one function to print in the console, and one to generate a markdown?)