Open bbartholdy opened 1 year ago
Yes, good observation, I agree with the need for this, though I have no idea frequently any of the options are used (I'm 'analysis' all the way, what is everyone else doing?). A pull request for the comprehensive solution that you mention would be most welcome!
This is a very small thing and may not be worth implementing, but maybe worth bringing attention.
Following a call to
use_readme_rmd()
, the generated README will include the## Contents
section with a reference to theanalysis
directory. However, the user is also given the option to use"inst"
and"vignettes"
aslocation
arguments in theuse_analysis()
function. This will result in broken links in the "## Contents" section of the generated README files.A quick solution would just be to add a warning that users may need to fix these links when using the
"inst"
and"vignettes"
arguments.A more comprehensive solution would be to generate the README filepaths based on what structure the user has already implemented (i.e.
analysis/
orinst/
). Although I'm not sure how feasible this is (for example if the user generates the README before usinguse_analysis()
).