Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Could include paper source code in repo? #56

Open
athowes opened this issue May 10, 2024 · 3 comments · May be fixed by #57
Open

Could include paper source code in repo? #56

athowes opened this issue May 10, 2024 · 3 comments · May be fixed by #57

Comments

@athowes
Copy link

athowes commented May 10, 2024

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
Copy link
Collaborator

seabbs commented May 10, 2024

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
Copy link
Author

athowes commented May 10, 2024

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
Copy link
Collaborator

seabbs commented May 10, 2024

"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

@athowes athowes linked a pull request May 20, 2024 that will close this issue
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging a pull request may close this issue.

2 participants