Script Metadata for Sharing
Since the PhUSE-Scrips repository was created i GitHub in 2013, many scripts were contributed and hosted in the repository. The Standard Analyses and Code Sharing Working Group (SACS) in PhUSE recommended style and guideline and developed qualification process to review, develop and share the scripts. Many developers from other working groups started using the repository to share and host their scripts as well. FDA contributed the JumpStart script packages to the repository as well. The script discovery and acquisition team in the working group has gone through two-round reviews of the the JumpStart scripts.
The working group has recommended folder structure, file naming convention, and initial script metadata in YML format. The difficulties facing the users are:
- Not easy to find scripts due to a) script metadata are not defined thus the metadata files are not consistent; b) the index page based on metadata files are not updated promptly
- Not easy to navigate in the repository due to a) scripts are not well organised; b) the folders are deep and complicated
- Not easy to use the scripts due to a) need to download the scripts; b) modify the scripts. You usually need to make change to the original script to make it work in your own environment.
Wouldn't it be nice if you could automatically download and execute a script once you know the name of a script and only need to provide a few parameters in a configuration file (script metadata file)? This project will explore how to use script metadata to increase the accessibility, reusability and automation of scripts in the repository.
The goal of this project is to clearly define script metadata in a white paper and conduct a proof of concept using the script metadata to drive the sharing and executing scripts in the repository. The scrips written in both R and SAS will be tested. Script metadata provides the information about the scripts purpose, version, execution environment, library and data files used, inputs, outputs, review history, ratings etc. The metadata will make it easy to share, access and execute scripts in the repository.
This project will be based on the paper published and presented in PhUSE EU annual conference by Hanming Tu
Paper: Defining Script Metadata for Sharing: Using PhUSE R Package as an example
Presentation: Defining Script Metadata for Sharing : Using PhUSE R Package as an example
|Hanming Tu||Project Lead||Frontagefirstname.lastname@example.org|
|Wendy Dobson||Project Manager||PhUSEemail@example.com|
|Jared Slain||Participant||MPI Research||Jared.Slain@mpiresearch.com|
|Sally Cassells||Participant||Next Step Clinical Systems||Sally.Cassells@nextstepclinicalsystems.com|
- Script metadata whitepaper (final) was published on Jan 3, 2019
- Script metadata whitepaper (draft)
- Jan 08, 2018: We kicked off the project, and here are the related links:
- Kickoff Meeting Presentation
- Volunteer Sign Up Form
- Whitepaper Template
- Paper: Defining Script Metadata for Sharing
- Presentation: Defining Script Metadata for Sharing
- Teamwork Project was created on Jan 10, 2018. Thanks to Wendy!
- R Reference:
- Date: January 2018. We are calling for volunteers and a co-lead for this project. If you are interested in participating please contact Hanming or Wendy.
Objectives and Timelines
List proposed project deliverables and timelines.
|Project Kick Off and Information Sharing||Q12018|
|White Paper development and public review||Q2/3 2018|
|PhUSE team follows up on adopting and using script metadata||Q42018|
Team Presentation Slide Deck 11.01.18