Difference between revisions of "WG5 Project 02"

From PHUSE Wiki
Jump to: navigation, search
m
(Ways to Contribute)
Line 64: Line 64:
 
* '''Test & Qualify''' scripts (either in the style proposed, or a style you propose and demonstrate)
 
* '''Test & Qualify''' scripts (either in the style proposed, or a style you propose and demonstrate)
 
* '''Write''' scripts for remaining targets (and, yes, basically all targets are still "remaining" at this time)
 
* '''Write''' scripts for remaining targets (and, yes, basically all targets are still "remaining" at this time)
* Review YML metadata files. We propose 2 types:
+
* '''Review''' YML metadata files. We propose 2 types:
 
:# YML for scripts (SAS and R) that describe the script, its purpose and its state
 
:# YML for scripts (SAS and R) that describe the script, its purpose and its state
 
:# YML for targets, language-independent specifications for the target output created by the SAS and R scripts
 
:# YML for targets, language-independent specifications for the target output created by the SAS and R scripts
 
* Other ideas (infrastructure, development, test automation, etc.)
 
* Other ideas (infrastructure, development, test automation, etc.)
 +
 
* Are you missing some information that would make it easier for you (or a colleague you know) to contribute? Let us know.
 
* Are you missing some information that would make it easier for you (or a colleague you know) to contribute? Let us know.
 
<br/>
 
<br/>

Revision as of 07:32, 19 June 2015


Project Team

Project Leads:

  • Dante Di Tommaso (dante.di_tommaso (at) roche.com)
  • Peter Schaefer (pschaefernet (at) yahoo.com)


Project Members, 2015:

  • Anders Vidstrup
  • Austin Taylor
  • Dirk Spruck
  • Frank Senk
  • Gustav Bernard
  • Jeno Pizzaro
  • Lina Jørgensen
  • Mercy Navarro
  • Peter Glass
  • Rebeka Tabbey
  • Shubha Manjunath
  • Suzie Perigaud
  • Terry Walsh
  • Yingshan You


If you want to participate, please simply contact Dante or Peter, above.

Project Description

Name: Repository Content and Delivery

Description:
One of the projects under WG5 Standard Scripts.

This working group relies on distributed volunteers to review, develop, test and qualify Standard Scripts for general use. Volunteers should be able to easily find ways to contribute, either by improving our processes or working directly on the qualification of Standard Scripts. In 2014, we defined a process and associated roles for qualifying repository code. See File:Qualification of CSS scripts.xlsx in Project Documents, below.

Moving forward in 2015
We will:

  • folder WPCT contains template programs for White Paper Central Tendencies
  • sub-folders separate outputs by script language, so we can store same-name outputs generated by both R and SAS scripts
  • output_r contain R outputs (same file names as SAS outputs)
  • output_sas contain SAS outputs (same file names as R outputs)
  • folder utilities contains SAS macros that the template programs require
  • folder specification contains consolidated specs for each Central Tendency target, extracted from the white paper and stored in yml-format
  • folder qualification contains test scripts that document the qualification of each component in WPCT and utilities
  • Notes about qualification:
  • 2014 proposal was to create a File:Qualification of CSS scripts.xlsx for each component to explain the qualification process and document tests and checks, as implemented for certification and confirmation stages
  • This now seems burdensome without real gain in accessibility or transparency
  • So we are now considering a simpler approach that remains similar in spirit: simply documenting tests and checks in scripts in the qualification folder, above.


Ways to Contribute

How can I contribute? There are many ways. Options include:

  • Stay informed by joining 3-weekly team TCs (contact Dante or Peter, above)
  • Review existing scripts, and there are a few types of code so far:
  1. scriptathon 2014 code, both SAS and R - Help us extract good techniques for our "Central Tendancy" package in SAS and R.
  2. SAS and R scripts for Central Tendency targets - Assess suitability for contributor and end-users. Suggest improvements.
  3. test code - Same as with SAS and R scripts. Assess suitability.
  • Test & Qualify scripts (either in the style proposed, or a style you propose and demonstrate)
  • Write scripts for remaining targets (and, yes, basically all targets are still "remaining" at this time)
  • Review YML metadata files. We propose 2 types:
  1. YML for scripts (SAS and R) that describe the script, its purpose and its state
  2. YML for targets, language-independent specifications for the target output created by the SAS and R scripts
  • Other ideas (infrastructure, development, test automation, etc.)
  • Are you missing some information that would make it easier for you (or a colleague you know) to contribute? Let us know.


Project Progress

Approach for 2015

  • Specify improvements to Repository metadata and interface
  • Specify improvements to Specifications for white paper targets, including how and where we document and publish
  • Revise the Qualification process


Notes from CSS annual meeting: 16-17 MAR2015

  1. Proceed with qualification process as proposed
  2. Exercise process on specific deliverable for 2015, the Central Tendencies package
  3. Use contributed code for ideas rather than trying to qualify contributed code
  4. Develop and deliver "Template programs with extras", as proposed in WG5 P02 Qualification Process for Standard Analyses


Qualification Process

Qualification of Scripts: The Steps, States and Tasks
The following table describes the steps of qualifying a script, artifacts, and how the progress is tracked by a state indicating how the script is progressing through the steps.

Step Resulting State Actors Artifacts Description
Requirements Analysis & Initial Script Development Created
  • Developer
  • SME
Establish
  • Specification YML
  • Script including header with To Do list (SAS or R)
  • Script YML
  • Create initial documentation for the script
  • Task card(s) in Trello
  • Maintain history of changes in Git
Developer
  • Extracts the specification from the white paper.
  • Consults with SME as needed
  • Creates the initial version of the script

Subject Matter Expert (SME)

  • Knows the intent of the data display
  • Advises and clarifies the requirements as needed

Developer & SME

  • Identify required data input, structure of input data, and any restrictions that might apply to the script or the data
Script Completion Completed
  • SME
  • Developer
Finalize initial artifacts.

Establish script outputs (SAS or R).

  • Task card(s) in Trello
  • Maintain history of changes in Git
  • Code complete status in software development, the scripts are considered to be
  • This requires testing by the developer, and review by the SME. This typically requires some iterations to establish intended behavior within an agreed scope.
Review and Qualification Tested
  • QA Expert
  • SME
  • Developer

Updated as needed

Objectives of this step:

  • Define test strategy and create and execute tests.
  • Confirm results in the formal qualification of the script.

Who does what:

  • QA Expert creates & SME reviews
    • Specify tests that establish intended behavior of the script and the test environment to be used (for example, OS, SAS/R version, etc.)
  • Developer and/or QA Expert create
    • Manual or automated test steps for the script]
  • QA Expert and/or SME review
    • Manual or automated test steps for the script
    • Expected test outputs (aka reference output)
  • QA Expert executes
    • Manual or automated test steps for the script
  • QA Expert and/or Developer updates
    • all artifacts as needed
Script Release Released
  • QA Expert
  • Technical Writer
QA Expert updates as needed

Tech. Writer updates source specification as needed (e.g., white paper)

  • Review and accept tests.
  • Document the completeness of this development cycle.
  • This step includes a final check that all files are in place and accessible before updating the script state to be "Qualified".

Comments from the team:

  • <add your comments, suggestions here>



Project Presentations & Posters



Project Documents


Project Meetings

2015 Agendas & Minutes


2013 CSS - Notes from the annual meeting



Last revised by DanteDT,06/19/2015