AbdnCHDS / guidebook

Our guide for open and reproducible ways of working in ACHDS
Other
3 stars 5 forks source link

R notebook - template file? #3

Closed BScheliga closed 8 months ago

BScheliga commented 4 years ago

@dblana, @JessButler Do you reckon it makes sense to create some sort of R notebook template file for the centre?

That provides a frame for R-scripts and forces some form of consistency across the R-scripts. Nothing much, but just to give people a starting point.

e.g.


title: "R Notebook for ???" author: [Enter Your Name] date: YYYY-MM-DD output: pdf_document

Data set created by
Author: [Enter Your Name]

#Enter the Version of the data set here, if applicable. Or else delete
Dataset_version <- "0.2"
#delete, if above does not apply
print(paste("Dataset version:", Dataset_version, sep = " "))
print(paste("Date:", Sys.Date()))
version$version.string

1. Summary:

[briefly describe what you are planning to do here]

2. Creating the data set

2.1 Loading Libraries

[...]

2.2 Loading source data

[...]

dblana commented 4 years ago

I think that's a great idea! Even if people don't want to use it exactly as it is, it would be a great starting point, especially for Rmarkdown beginners 👍

BScheliga commented 4 years ago

I will upload something short and sweet later

dblana commented 2 years ago

@BScheliga your template is still there, I just renamed it: https://github.com/AbdnCHDS/guidebook/blob/master/R/Template_R_Notebook.Rmd

BScheliga commented 2 years ago

@dblana thank you. What do we do now with it :)

dblana commented 8 months ago

Link added from guidebook, we can review later on!