13:30 - 13:45 | Introduction and outline |
13:45 - 14:15 | R Package Syntax |
14:15 - 15:00 | Software Engineering Workflow |
15:00 - 15:15 | Tea Break |
15:15 - 16:00 | Package Quality |
16:00 - 17:00 | Collaboration via GitHub |
17:00 - 17:30 | Summary and Discussion |
Good Software Engineering Practice for R Packages
Welcome to the homepage of the workshop “Good Software Engineering Practice for R Packages”. In this course participants will learn hands-on skills and tools to engineer reliable R packages used in biostatistics. The day will be a mix of presentations and exercises. Participants need to be comfortable with writing functions in R and use their own laptops.
Up-coming Event
The next event will be on-site, at the Beijing Marriott Hotel Northeast, on August 1st, 2024. Please note that all the content will be in English, delivered in English and Chinese. This event is sponsored/organized by PharamaSUG and advertised also through the R User Group (RUG) China. Presenters will be Liming Li and Joe Zhu.
Future Event
Our volunteers are working with DIA for future event planning. Stay tuned …
Workshop Program
This is the program for 1st August 2024, all times in China Standard Time (GMT+8):
Prerequisites & Technical Setup
Prior to the course, participants should
- set up a (free) GitHub.com account. There are other git Platforms like Gitlab or Bitbucket but we made the choice to go with GitHub.com for the course since it is by far the most relevant git platform in the R community.
- download and extract simulatr.zip
- either make sure they have a working R software development setup on their own laptop (up-to-date git/Rtools/R/RStudio) or get access to https://posit.cloud. The latter offers a free tier account with 25 hours of computing time per months and can be accessed using ones GitHub.com account.
- in your rstudio terminal, set the ssh key by
ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
, then use commandcat ~/.ssh/id_rsa.pub
to show your public key, and copy and paste it to https://github.com/settings/keys, with the name “pharmasug-2024-key”.
For the course, participants are required to use their own laptop to be able to participate in the exercises.
Optional reading list
- Excellent and very comprehensive R Packages (2e)
- (Hardcore) description of how Writing R Extensions works
- GitHub ‘Hello World’ tutorial on how to use GitHub.com (does not require git command line knowledge)
- Tutorial on version control with git and SVN (we will be using git)
- Command line git mini intro trygit
- first steps with git & github by RStudio
- RStudio cheatsheets/ Git & GitHub
Past Events
- 24th March 2023, Shanghai
- 10th February 2023, Basel