search

krlmlr / vistransrep

zhrCourses live demo
https://krlmlr.github.io/vistransrep
0 stars 1 forks source link

About file organization and caching #20

Open pat-s opened 4 years ago

pat-s commented 4 years ago

I've seen that you make use of Rmd childs quite heavily.

This is nice for file organization. However it is tedious if once wants to add a chapter/section (especially section) later on. All files need to be renamed to maintain the naming scheme.

Another, maybe more practical issue, is the case of caching. Due our work on the mlr3book, we've found that caching only works reliable on the chapter level.

Meaning if there is one Rmd per chapter (with one l1 heading) and one sets 

knitr::opts_chunk$set(cache = TRUE, cache.lazy = FALSE)

Then caching via bookdown::serve_book() works reliable. We've had a similar nested file structure before and it was just a pain.

I don't want to force a change but just raise a discussion about this. Maybe you agree and also feel more comfy with this when adding/changing content.

Downside: Somewhat large Rmd's which contain the content of complete chapters. At least one can navigate using the RStudio Rmd outline. But at some points its tedious.

Another hint: We've also written a small fun for automatic naming of the chunks of each Rmd: https://github.com/mlr-org/mlr3book/blob/03374e976b8d767d7088579bb878bc774d133199/R/name_chunks.R

krlmlr commented 4 years ago

qmv largely solves the file reorganization issues.

The children are tied to individual scripts which I'd like to maintain. Merging might be possible but will involve infrastructure change. Maybe later?

pat-s commented 4 years ago

Ok I see. What is qmv and how do I use it? Never heard of it and google didn't help.

krlmlr commented 4 years ago

On some platforms you can apt install renameutils.

https://www.nongnu.org/renameutils/

krlmlr commented 4 years ago

qmv . opens an editor where you can edit a rename recipe for all files in the directory. After quitting the recipe is applied.

pat-s commented 4 years ago

Looks interesting. Thanks!

pat-s commented 4 years ago

I've tried qmv. While it helps for bulk-renaming, it does not help when adding a new "01-foo" file to a list of files spanning a integer prefix range from 1-X. I need to touch every file then. Or did I miss something?

krlmlr commented 4 years ago

I agree it removes some of the pain, not all of it. Maybe you can teach your text editor to increase numbers in a clever way? Gaps in the sequence help too.

krlmlr commented 4 years ago

I prefer caching off for now.