showyourwork / showyourwork

A workflow for reproducible and open scientific articles

Home Page:https://show-your.work

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Update overview figure to include other language scripts

MilesCranmer opened this issue · comments

The overview figure has the "Python" logo next to the "pipeline scripts" and "figure scripts":

image

I think this is misleading for people checking out the project because they may immediately think their {Julia/R/Rust} scripts can not be used in their SYW project. (In fact, the reason I am aware of this issue is because a Julia person thought they couldn't use SYW). However, Snakemake has native support for all four: https://snakemake.readthedocs.io/en/stable/snakefiles/rules.html#external-scripts, and is also able to execute arbitrary shell commands.

@rodluger would you happen to have the source file for this overview figure? I'd propose that we either tweak it to have other language logos, or just remove any particular language's logo altogether. What do you think @dfm?


side note: it could be useful to include paths.jl, paths.rs, paths.R in the cookie-cutter template. Maybe we could have a "languages to support" option when creating the template repository that would download the needed scripts in each case, and update the showyourwork.yml file to map the filetypes.

+1 All good with me!