parksw3 / epidist-paper

Other
10 stars 4 forks source link

Could include paper source code in repo? #56

Open athowes opened 6 months ago

athowes commented 6 months ago

I can't find the source code for the paper in this repository (perhaps I'm missing it?). If there aren't good reasons for it not to be uploaded, I think it would be nice for the whole paper (e.g. as .Rmd or .qmd) to be able to be reproduced based on the repository code. I don't think this is a major value add, just all else equal a nice to have.

seabbs commented 6 months ago

So you can reproduce the whole paper using the repo code but it may not be clear how to do that. This was a straight to LaTex paper so no literate coding here.

athowes commented 6 months ago

By "can reproduce the whole paper" do you mean "you can output the PDF" or "you can output all of the analysis and figures that populates the PDF"?

If the former, could you point me to the location of the .tex code for the paper?

If the later, fair enough. Perhaps the README could be rewritten to highlight how to reproduce the analysis. Side issue perhaps, but the current code in the README could be moved to the package vignette (I think these might be the same anyway?) and just linked to (when the package website is up) rather than have it all here.

seabbs commented 6 months ago

"you can output all of the analysis and figures that populates the PDF"?

I mean the latter.

Perhaps the README could be rewritten to highlight how to reproduce the analysis. Side issue perhaps, but the current code in the README could be moved to the package vignette (I think these might be the same anyway?) and just linked to (when the package website is up) rather than have it all here.

Yes I agree clarity on how to reproduce would be great here I think