Difference between revisions of "User Guide for Standard Script Repository"

From PHUSE Wiki
Jump to: navigation, search
m (Introduction)
 
(2 intermediate revisions by the same user not shown)
Line 3: Line 3:
 
=Introduction=
 
=Introduction=
  
Welcome to the phuse-scripts repository. This site hosts standard scripts for data transformations and analyses across and/or within a therapeutic area and exploratory analysis. Our goal is to standardize analyses across the industry, but also include examples of what can be done with a standardized data set. We aim to establish this repository as the place to collaborate and share between industry and regulators.
+
Welcome to the CSS/PhUSE Standard Analyses. Our [https://github.com/phuse-org/phuse-scripts/|github repository] hosts standard scripts for data transformations and analyses across and within a therapeutic area, as well as for exploratory analyses. Our goal is to standardize analyses and code across the industry, and to provide other examples of how our industry can build upon standardized data set. We aim to establish this repository as the place to collaborate and share between industry and regulators.
  
 
=How to get involved=
 
=How to get involved=
Line 29: Line 29:
 
Users should add documentation when adding a script.  We have templates for:
 
Users should add documentation when adding a script.  We have templates for:
 
* User documentation (locate in github)
 
* User documentation (locate in github)
* Script specifications (locate in github)
+
* [https://github.com/phuse-org/phuse-scripts/blob/master/MetaData_template.yml Script specifications in YML]
 
We have naming conventions:
 
We have naming conventions:
* Naming conventions (locate in github)
+
* [https://github.com/phuse-org/phuse-scripts/blob/master/naming_conventions_proposed.txt Naming conventions]
  
Please use these documents for new scripts. and adhere to naming conventions.  
+
Please use these documents for new scripts, and adhere to naming conventions.  
  
 
----
 
----

Latest revision as of 07:44, 7 January 2016


Introduction

Welcome to the CSS/PhUSE Standard Analyses. Our repository hosts standard scripts for data transformations and analyses across and within a therapeutic area, as well as for exploratory analyses. Our goal is to standardize analyses and code across the industry, and to provide other examples of how our industry can build upon standardized data set. We aim to establish this repository as the place to collaborate and share between industry and regulators.

How to get involved

Repository Maintainer
Hanming Tu and Kevin Kane : contact on code@phuse.com
Current members
https://github.com/orgs/phuse-org/people
Steps to join
  1. Join the Free PhUSE mailing list to receive updates http://goo.gl/R8q8V
  2. Sign up for the PhUSE working group mailings
    1. Go to www.listbox.com
    2. Join this group: "CSS WG5: Developing Standard Scripts" (CSS-WG-Standard-Scripts@listbox.com)
  3. Sign up to be a contributor or committer in the script repository (GitHub account required)
    1. Send an email to one of the repository maintainers to request to join the PhUSE repository
    2. Go to repository at https://github.com/phuse-org/phuse-scripts/ and start interacting

Adding a script

There are two methods to add a script:

  1. using browser or
  2. using a git client such as the GitHubs client.

Repository structure is a work-in-progress, with the proposed structure published in the repository.

Users should add documentation when adding a script. We have templates for:

We have naming conventions:

Please use these documents for new scripts, and adhere to naming conventions.


Last revised by DanteDT,01/7/2016