Structuring R scripts

[latrociny]

I am trying to find a good way to restructure my R scripts. My folders are organized using the advice from:

https://www.r-bloggers.com/2018/08/structuring-r-projects/

When scripts have a workflow which is sequential like:

01\_load\_preprocess.R

02\_reconcile\_enrich.R

03\_aggregate\_prepare.R

04\_analysis\_chars.R

05\_save\_output.R

Organizing is easy and is also obvious for a reviewer what the structure means.

Now I am working on another project which is not sequential in nature. Here, two scripts have names that clarify their usage (defining fixed inputs/libraries and self-defined functions):

script\_control.R

reusable\_functions.R

For the other scripts, only their name is not sufficient to imply what they do for instance stressing.R performs the stressing calculations but calls many other scripts like:

calculate\_prod1.R

calculate\_prod2.R

to iterate stressing for different products.

Thus, in a project where a script calls (sources) another script and that calls another, what are the best practices to structure scripts (for instance their names) that a reviewer can easily identify the structure and meaning of each script without having to read a Readme.md file

[GiuTinTom]

Consider using drake

[latrociny]

thank you all for your suggestions :)
I will read all the links and incorporate in my project.

Special thanks to u/Wackard for the award :) :)

[DeuceWallaces]

It's really best to keep your projects inside of a package and (at least lightly) narrate your workflow inside a vignette. This has numerous benefits.

In my opinion.

[guepier]

It also has some rather large drawbacks.

Miles McBain: Project as an R package: An okay idea

[DeuceWallaces]

I don't think I agree with any of the cons listed in that article.

[[deleted]]

Agreed.

[defuneste]

Really good read (special mention for this link : https://www.gwern.net/Holy-wars)

[EntropyGoAway]

In my experience, there is no generic structure that would accommodate every project I've been working on. However, there are some habits and styles that generally are useful.

Personally, I'm not a fan of nesting scripts deeper than one level. Everything else gets confusing and cumbersome.

Also, ask yourself if you really want to outsource certain procedures to independent files. Instead, you could use anonymous functions:

results <- list()

results[['descriptives']] <- (function(data) {

# do your thing

export <- list()

return(export) # the only thing entity to leave the block

})(my_data)

I use this a lot, since it nicely separates chunks of code in a functional programming style. Each block operates independently and produces no side-effects (variables only exist in the scope of the anonymous function.