Advantages

• R package development process

• Native to programmers

• Satisfies requirements

• Iterative development

• Reusable

• What is the thing?
• What will the thing do?
• What are the expected ouputs?
• What are the high level steps that need to be followed?

- My presentation will 
  - The contents will cover my teams approach to validation
  - Be 15-20 minutes long
  - Be entertaining 

Specification Files

• markdown format

• Single file per specification

• Clearly defined

• Independent

• Close proximity to the task

Key Information to capture

• Who wrote the specifications
• When they wrote it

Documenting Code

• Who wrote the code

• When they wrote it

• Update ownership when code are updated

Roxygen Tags

• @section Last Updated By:
• @section Last Update Date:

Value

• Close proximity to the task
• Natural extension of documentation already being performed
• Adds to documentation of functions

#' @title Deliver Jokes
#' @description 
#'    Deliver jokes with punchlines. Wait 3 seconds for the punchline.
#' @param Setup Joke setup
#' @param Punchline Joke punchline
#' @examples
#' joke('To the person who stole my presentation -','I hope you do not Excel.')
#'      
#' @section Last Updated By:
#' Ellis Hughes
#' @section Last Updated Date:
#' 2030/01/01

joke <- function(Setup, Punchline){
  print(Setup)
  Sys.sleep(3)
  print(Punchline)
}

#' @title Deliver Jokes
#' @description 
#'    Deliver jokes with punchlines. Wait 3 seconds for the punchline.
#' @param Setup Joke setup
#' @param Punchline Joke punchline
#' @param wait how long to wait to serve the punchline
#' @examples
#' joke('Why did the PowerPoint Presentation cross the road?','To get to the other slide.')
#'      
#' @section Last Updated By:
#' Joe King
#' @section Last Update Date:
#' 2030/04/01

joke <- function(Setup, Punchline, wait = 3){
  print(Setup)
  Sys.sleep(wait)
  print(Punchline)
}

Good Test Cases

• Goals of the test case
• Specify the required data
• Recipe to get to output
• Clear Expectations

Documenting Test Cases

• Who wrote the Test
• When they wrote it
• Which specifications are satisfied

Roxygen Tags

• @section Last Updated By:
• @section Last Update Date:
• @section Specification coverage:

#' @section Last Updated By: 
#' Ellis Hughes
#' @section Last Update Date:
#' 2030/01/01
#' @section Specification coverage:
#' T1.1: S1.1, S1.2, S1.3

+ _Test Cases_

+ Setup: Create Presentation 
  
+ T 1.1 Test that specifications 1.1, 1.2, and 1.3 are met by practicing presentation on unsuspecting co-workers

  - Present to a captive audience of coworkers and later your significant other
  + T 1.1.1 Test that the presentation was informative by asking what your audience learned.
  + T 1.1.2 Time the presentation and make sure it was between 15 and 20 minutes.
  + T 1.1.3 Test that you were entertaining by counting the amount of chuckles (>3)
      + T 1.1.3.1 Alternatively, eye-rolls from your significant other (>4)

• Implement Test Cases

• Record results

• Third Party

Benefits

• Resolves interpretation errors
  • documentation
  • test cases
• Identify improvements

Documenting Test Code:

• Who wrote the Test Code
• When they wrote it

Roxygen Tags

• @section Last Updated By:
• @section Last Update Date:

#' @title T1.1
#' @section Last Updated By: 
#' Jess Terr
#' @section Last Update Date:
#' 2030/01/01

test_that('T1.1',{
  
  joke_result <- joke('What do you call a fake noodle?','An Impasta')
  expect_true(is_dad_joke(joke_result))
  expect_true(caused_laugher(joke_result))
  expect_true(embarrased_significant_other(joke_result))
  
})

{testthat}

• Familar framework
• Can run and developed interactively
• Automation

Reporter Objects from {testthat}

• Track each test and expectation
• Reports success
• Records failure mode

|  OK F W S | Context
|   3       | test_case_001 [3.2 s]

-- Results ---------------------------------------
Duration: 3.2 s

OK:       3
Failed:   0
Warnings: 0
Skipped:  0

Using a custom function to extract results from Reporter object

What we have so far

• 1. Specifications
• 2. Code
• 3. Test Cases
• 4. Test Case Code
• 5. Validation Documentation

Final Elements Required

• Sign off page

• Environment information

  • R version
  • Package dependencies and versions

-- DESCRIPTION
-- man
-- NAMESPACE
-- tests
-- R
  |__jokes.R
-- vignettes
  |__Validation.Rmd
  |__Validation.pdf
  |__Validation
    |__Specifications
      |__specification_001.Rmd
    |__Test_Cases
      |__test_case_001.Rmd
    |__Test_Code
      |__test_code_001.R