rjdverse / rjd3revisions

Revision analysis tool
https://rjdverse.github.io/rjd3revisions/
European Union Public License 1.2
3 stars 5 forks source link

Other output_format for `get_format` #6

Closed AQLT closed 2 months ago

AQLT commented 6 months ago

Since the template is simple, it could be good to enable other output_format than only html. Moreover, not at it is not recommended to write by default in users home filespace.

TanguyBarthelemy commented 6 months ago

hi Alain, Yes it would be interesting to be able to export the report in other formats (pdf for example).

Also, the path.out argument currently allows you to choose the destination of the generated file. But what is your opinion when the user does not provide a path. Is it better to return an error or choose another path? Here the default destination is not home but the working directory of the user's project, is it a bad practice? https://github.com/rjdemetra/rjd3revisions/blob/86696a12dcb41afa617c6731f0fac5c47aee2c0d/R/report.R#L47

AQLT commented 6 months ago

Hi Tanguy, On the path.out option it is not allowed by CRAN policies (also in examples/vignettes). For CRAN we must only write/save files if the user has specified a directory in the function themselves. That's why the RJDemetra::save_spec() uses by default the tempdir() function, RJDemetra::save_worskpace() example use a tempdir() and rjwsacruncher::create_param_file() doesn't have any default directory

TanguyBarthelemy commented 6 months ago

Ok so:

TanguyBarthelemy commented 2 months ago

We extended the output to .pdf and .html. Maybe to .docx files but there are some problem with the tables currently.

TanguyBarthelemy commented 2 months ago

I think this issue can be closed.