Difference between revisions of "User Guide for Standard Script Repository"
(→Add script through browser) |
m (→Introduction) |
||
(20 intermediate revisions by 7 users not shown) | |||
Line 3: | Line 3: | ||
=Introduction= | =Introduction= | ||
− | + | 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= | ||
− | ; Repository Maintainer: Hanming Tu | + | ; Repository Maintainer: Hanming Tu and Kevin Kane : contact on code@phuse.com |
− | ; Current members: | + | ; Current members: https://github.com/orgs/phuse-org/people |
;Steps to join: | ;Steps to join: | ||
− | # Join the PhUSE mailing list to receive updates http://goo.gl/R8q8V | + | # Join the Free PhUSE mailing list to receive updates http://goo.gl/R8q8V |
# Sign up for the PhUSE working group mailings | # Sign up for the PhUSE working group mailings | ||
## Go to www.listbox.com | ## Go to www.listbox.com | ||
− | ## Join this group: | + | ## Join this group: "CSS WG5: Developing Standard Scripts" (CSS-WG-Standard-Scripts@listbox.com) |
− | # Sign up to be a contributor or committer in the script repository | + | # Sign up to be a contributor or committer in the script repository (GitHub account required) |
− | ## Send an email to one of the repository maintainers to request to join the | + | ## Send an email to one of the repository maintainers to request to join the PhUSE repository |
− | ## Go to repository at https:// | + | ## 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: | |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
# using browser or | # using browser or | ||
− | # using | + | # using a git client such as [https://help.github.com/articles/set-up-git/ the GitHubs client]. |
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
− | |||
+ | Repository structure is a work-in-progress, with [https://github.com/phuse-org/phuse-scripts/blob/master/folder_structure_proposed.txt the proposed structure published in the repository]. | ||
+ | Users should add documentation when adding a script. We have templates for: | ||
+ | * User documentation (locate in github) | ||
+ | * [https://github.com/phuse-org/phuse-scripts/blob/master/MetaData_template.yml Script specifications in YML] | ||
+ | We have naming conventions: | ||
+ | * [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. | ||
---- | ---- | ||
Line 100: | Line 39: | ||
[[Category:WG5]] | [[Category:WG5]] | ||
− | [[Category:Standard | + | [[Category:Standard Scripts]] |
[[Category:Guideline]] | [[Category:Guideline]] | ||
[[Category:Repository]] | [[Category:Repository]] | ||
− | [[Category: | + | [[Category:HowTo]] |
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
- Join the Free PhUSE mailing list to receive updates http://goo.gl/R8q8V
- Sign up for the PhUSE working group mailings
- Go to www.listbox.com
- Join this group: "CSS WG5: Developing Standard Scripts" (CSS-WG-Standard-Scripts@listbox.com)
- Sign up to be a contributor or committer in the script repository (GitHub account required)
- Send an email to one of the repository maintainers to request to join the PhUSE repository
- 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:
- using browser or
- 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:
- User documentation (locate in github)
- Script specifications in YML
We have naming conventions:
Please use these documents for new scripts, and adhere to naming conventions.
Last revised by DanteDT,01/7/2016