rstudio / rticles

LaTeX Journal Article Templates for R Markdown

https://pkgs.rstudio.com/rticles/

1.47k stars 519 forks source link

Only overwrite the purled file if this our file. #439

Closed cderv closed 3 years ago

cderv commented 3 years ago

This closes #433 by providing a new mechanism into rjournal_article() to avoid overwriting any existing R file user maintained

Current behavior

rjournal_article() will purl the Rmd file to produce an R file with the same name as the output name for tex file and pdf file.
Since version 0.20, we were overwriting any existing R file.
This causes issue for users who maintain their own R script and don't want the purled one.

See https://github.com/rstudio/rticles/issues/394#issuecomment-894316281

New behavior

rjournal_article() generates a file which add a special custom header comment so that RStudio IDE sees this file as read only
With this header we can detect if file is our own or not.
If we see the R file is not generated by rticles, a warning is issued and purled file is no copied into the output folder.

Possible other solution

We do less magic and just offer a switch in the format to deactivate the purling
```
output: 
rjournal_article: 
  purl: false
```
which would default to true, but can be set to false for those who needs to maintain their R file.

@yihui can you review this to give your thoughts on the current solution and possible other one ?

Thank you.