Tables, Figures, & Listings
Each analysis can have a collection of Tables, Figures, Listings.
Users can track TFL metadata (including Title and Footnotes), QC/Test Results and Issues (bugs, change requests).
As of the 2.15 release we added the new TFL Grid.
Now, there are two options for viewing, sorting, filtering TFL metadata:
- Original TFL Index
- New (Beta) TFL Grid
To access the new TFL Grid:
- Navigate to the TFL Index for a given Analysis.
- Click the TFL Grid button in upper right corner of the TFL Index page.
- The TFL Grid behaves similar to an Excel spreadsheet. You can use most sorting, filtering, column re-ordering, etc. behavior just like in Excel.
- Double-click a cell to edit a value.
- Fill-handle updating is supported.
We are collecting feedback from customers on the TFL Grid and will be expanding its use across Candid in future releases.
TFL Index
- Navigate to the Analysis that contains the TFLs you would like to view.
- In the upper, right corner of the Analysis Details page, click TFL (42) link (must be listed as a Statistician or Programmer on the team to access).
-
The TFL Index page displays all the TFLs defined for the Analysis, their status, current version, current review period status and titles.
-
Star – click on the star to mark the TFL as a favorite.
-
Status – displays the current status of the TFL.
-
TFL – displays TFL details:
Example:t-txt-emergent-0001 v2 | r1Efficacy | Table | t-txt-emergent.sasKey:Name version number | last review period this TFL was inTFL Type Name | Name of SAS program generating this TFL-
Number – For example, '12.0.0.1'. Numbers can be left blank and assigned at any time during the lifecycle of the TFL.
-
Sort – For example, '0', '1', '1.01'. The sort field can be used by teams to custom sort TFLs when the name or number are not appropriate or effective. This value defaults to 0.
-
Class – For example, 'Efficacy, Safety, or Other'. Classes are a drop-down list managed by your Administrator.
-
Group – For example, 'Top-line'. Groups are a drop-down list managed by your Administrator.
-
Uploaded – 2022-04-28. The Uploaded column displays the creation date of the most recent uploaded file for a given TFL record. If a file has not been uploaded yet, the cell will be empty.
-
Titles – only the 2nd thru n titles are shown (Title 1 is the same for each TFL, some organizations refer to this as Title 0).
-
Assignments – displays assigned programming responsibilities:
- P = Programmer
- T = Tester
- S = Statistician
-
Filter TFL Index
There are 3 different tools to help you filter the TFL Index page. These filters can be used together to achieve narrower results (e.g., filter by Status to only show TFLs in Programming status, then use the Starring tool to only show starred TFLs):
1. The Status filter
- In the upper, left-hand corner, locate the heading that reads, TFLs at <status> (#).
- Click the status to change listed in the Status drop down (depending on your configuration it may look similiar to the following:
- READY or TESTED
- NEW
- PROGRAMMING
- READY
- TESTED
- STAT REVIEWED
- TEAM REVIEWING
- COMPLETED
- CANCELED
- SHOW ALL
2. The Type to filter input box
- In the upper, right-hand side, click inside the text box that reads, Type to filter.
- Enter your search criteria.
- Hit
Enter
key or click the button.
Filtering rules:
- Filter results will be applied (include) to all data visible in the index
- To isolate an exact text match put double quotes around the text in the filter (e.g. "treatment")
- If you have spaces in your filter, put spaces around the text (e.g. "treatment group A")
- If there are spaces in the column name replace the spaces with underscore characters (e.g. @SDLC_status treatment)
- Apply filter to a specific column, prefix the filter with the @ symbol and the column name (e.g. @titles treatment)
- Apply filter to more than one column by adding multiple column references in the input box (e.g. @tfl t-disp @titles treatment)
Examples:
- Apply free text, greedy filter: enter a value with no quotes: treatment
- Apply exact match filter: enter a value with quotes around it: "ldisp"
- Specify exact match on a column: @tfl "ldisp"
- Specify multiple columns: @tfl ldisp @assignments chris
- Specify an assignment role: @tester chris or @programmer chris
Filter column name map:
- TFL Index Name -> Value to use in filter
- TFL -> @tfl or @name
- Sort -> @sort
- Class -> @class
- Group -> @group
- Uploaded -> @uploaded
- Titles -> @titles
- Assignments -> @assignments
- Assignment Role Name -> @tester or @programmer or @statistician
3. The Starring tool
The Starring tool allows you to create your own custom filtered list. The starred TFLs remain starred until you change them, even if you log out and back in.
- Set any desired filters, following the instructions in the sections above.
- In the left-hand column, click the star icon in the row of the TFL you would like to mark.
- Alternatively, under the Status filter, there are 3 options:
- Star All – stars all TFLs in the current list (obeys filter). - Unstar All – un-stars all TFLs in the current list (obeys filter). - Show Starred Only/Show All – toggles whether to show only starred TFLs or all TFLs in the current list.
Add TFLs
There are several ways to add TFL metadata to an analysis:
- Using Excel (using an auto-generated Excel template by Candid).
- From standards that exist in the Template area.
- By cloning from another, existing analysis.
- By adding them one at a time on the TFL Index page.
Add TFLs via Excel
- Navigate to the Analysis you would like to edit.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the drop down menu.
- Click the Export to Excel link.
- Candid will generate an Excel spreadsheet containing all existing TFLs in the system and their titles, footnotes.
- Add new TFLs (rows) to the spreadsheet. Leave columns A and B blank. They are for system use only.
- Save the spreadsheet on your local machine.
- Import the spreadsheet:
- From the TFL Index page, click the button.
- In the dropdown menu, click Import link.
- In the TFL Import wizard, click the button.
- Click the button.
- On the TFL Import Preview page, note the changes that will be made if you continue importing the spreadsheet
- If everything looks correct, click the button.
- Confirm all of your changes are reflected correctly in the TFL Index.
- Delete the spreadsheet file from your local system.
Add TFL from Standards Template
- Navigate to the Analysis you would like to edit.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the button.
- Click Add from Template link.
- Click the button to choose a Template Group.
- Click the button.
- Select a TFL template definition from the list of templates in the group.
- Click the button:
- Fill-in the value for reach replaceable token defined in the template. - For each token, you can add one value at a time, or you can add multiple options separated by the "pipe"|
character (e.g., for the "Population" variable: ARM A | ARM B | ARM C). - Click the button to add another TFL with different token values. Create as many as you need and click the button. - The Confirm page displays a summary of the TFLs the system will create.
- Click and the wizard will add the new TFLs (and their titles, footnotes and any instructions you provided) to your Analysis. The new TFLs will be set to New state, and an audit trail record will be added indicating the date, time, and name of the user who added them.
- The Review Results screen will show a status bar while Candid finishes creating your TFLs.
- When the status bar reaches 100%, click the button.
Add TFLs by cloning from another analysis
- Navigate to the Analysis you would like to edit.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the button.
- Click Clone link.
- Click the button to expand the drop down and choose a source analsis to copy TFLs from.
- Click the button.
- Select 1 or more TFLs from the list by checking the boxes.
- Click the button.
- If you want to auto-edit and text in titles or footnotes enter values into the search and replace terms (you can add more than 1 set of terms to find and replace).
- Click the button.
- A summary of the actions to be taken are shown.
- Click and the wizard will add the new TFLs (and their titles, footnotes) to your Analysis. The new TFLs will be set to New state, and an audit trail record will be added indicating the date, time, and name of the user who added them.
Add TFLs one at a time
- Navigate to the Analysis you would like to edit.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the button.
- Choose the appropriate Type and Class from the dropdown menus
Type – the available types are defined by the Administrator; common options include: table, listing, or figure. Class – the available classes are defined by the Administrator; common options include: efficacy, safety.
- Enter the Name and Number (optional; can be updated later) into the text fields.
- Click the button to add.
- Add another TFL by following steps 1-6 above, or click the button to get out of Add mode.
Edit TFL Metadata
TFLs can be edited one at at time but, there are several powerful bulk management tools for updating TFL data and progress.
Edit TFL metadata from details page
- Navigate to the Analysis you would like to work on.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the button for the TFL you would like to view.
- On the TFL Details page, you can view the TFL's status, download a PDF of the TFL, update team assignments, edit titles and footnotes, review issues, add test results, or upload the TFL's file.
TFL Detail Sections:
Status
Displays an overview of the TFL's workflow; the current status will be highlighted and underlined.
Stat Reviewed -> Team Reviewing -> Completed
Details Displays TFL metadata: such as the class type name, program, and source template; under Version History, you can view the version history of the TFL, download a PDF copy for your records, and if the TFL is in a review period, click on the hotlink to go directly to the Review Period Details page.
Titles & Footnotes Displays the Type, Order #, and Value for each item; click the button to modify items individually, or click the button button to delete items individually.
Issues Displays all issues associated with this TFL: the Status (Open or Closed), Description, and Resolution for each issue on the TFL; to view an issue in more detail, click the button.
Test Results For each test result, view the Status (Failed or Passed), Description, Test Method, Program, and Issue; you can also edit or delete individual test results by clicking on the and buttons, respectively.
Status Changes Lists the TFL workflow audit trail.
Edit TFL metadata using Excel
STEP 1: Generate the Excel file representing the current state of TFL metadata for a given analysis.
- Navigate to an existing Analysis.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the button and Candid will generate a TFL spreadsheet containing any existing TFLs in the system (it will automatically be saved to your Downloads folder on your machine).
STEP 2: Update existing rows or add new rows to the spreadsheet (see Excel Column Structure & Rules)
STEP 3: Import the modified Excel file containing your changes.
- From the TFL Index page click the button.
- Click Import
- Click Choose File to select the spreadsheet file you have been working on.
- Click button.
- A Review and Confirmation page will open showing all the changes the system will make.
- Click to submit changes (or click ).
STEP 4: Delete the spreadsheet file from your local system.
Change Status in bulk
- Navigate to the Analysis you would like to edit.
- Click the TFL index link in the upper, right-hand corner of the page (above the TFL status doughnut chart).
- Click the button.
- Click
- Click the green, left-hand drop down menu to select the FROM status, e.g: Programming, Ready, Tested, Stat Reviewed, Completed, or Canceled.
- Click the green, right-hand drop down menu to select the TO status.
- Click .
- Check the box next to each TFL you would like to update.
- Click
- The next step will ask you to confirm your changes; click to proceed.
- Candid will display the results of your status update; any errors will also be displayed.
- Click .
Upload files in bulk
- From the TFL index page click the button.
- Select the Upload option and the Bulk Upload form will open.
- Click the button and File Explorer will open.
- Select 1 or more files from within File Explorer and click Open (optionally, you can drag and drop a folder from File Explorer to the Bulk Upload page, but this feature works only if you are using the Chrome browser).
- Candid will 'stage’ the files for upload (you can delete any files from the staging area you do not want included in the upload).
- Click the button and the Review Bulk Upload TFLs form will open.
- Use the checkboxes to select the file(s) you want to upload (files are matched to the TFL record in Candid by Name against the file names you ‘staged’).
- Click (or click ).
Update assignments in bulk
- From the TFL index page click the button.
- Select the Manage Assignments option.
- Click the button begin adding users, or click to begin removing assigments.
- Click
- In the left-hand dropdown list, select the role you would like to add.
- Click on the empty box and choose the desired name of the person who has the role you selected above.
- Click the button.
- Repeat steaps 5 through 7 for additional roles/users you would like to add to add/remove.
- For each TFL to which you would like to add your selected users, click the checkbox in the Selected column.
- Click
- If the assignments are correct, click the button, if everything is correct.
QuickView
QuickView a place for the Team (Statisticians and Programmers) to view TFLs and discuss changes, bugs, or any topic around their development. In Candid's default configuration only Statisticians and Programmers can access QuickView. See the Review Period topics for how to share and collect feedback from members outside the Biometrics team.
QuickView allows:
- View uploaded TFL files
- Add discussion item or ask a question about TFLs
- Elevate a discussion item to an Issue
- View and Add Issues
Access QuickView
- Navigate to the TFL Index for an Analysis
- Click button in the upper right-hand corner of the screen.
- Or, Click button for a TFL in the TFL index.
Add Discussion Item
- Navigate to QuickView
- On the Discussion tab, Click .
- An input box will display. Enter your discussion item and click .
Reply to Discussion Item
- Navigate to QuickView for a TFL.
- On the Discussion tab, Click button below the discussion item to reply to.
- An input box will display. Enter your reply and click .
Elevate a Discussion Item to an Issue
- Navigate to QuickView for a TFL.
- On the Discussion tab, Click drop-down button next to the Discussion Item to elevate.
- Click Convert to Issue.
- New Issue will be created, a link to the Issue will be displayed under the discussion item.
View Issues
- Navigate to QuickView for a TFL.
- Click the Issues tab.
Add Issue
- Navigate to QuickView for a TFL.
- Click the Issues tab.
- Click .
- An input box will display. Enter your Issue text and click .
Open Issue Details
- Navigate to QuickView for a TFL.
- Click the Issues tab.
- Click button to the right of the Issue to open details page.
Completed TFLs
Analysis team members can view the set of completed TFLs by accessing the Completed TFLs index.
- Navigate to the Analysis details page.
- Click the button (where 42 is the number of completed TFLs).
- Users can sort and filter the list.
- User can click the button to open the pdf in a browser tab (or if the TFL is a different file type, the file will be downloaded into your Downloads folder).
- User can click the to create a zip archive file of all the TFL files in the index.
Excel TFL Worksheet Column Definitions
-
Column A
Id: DO NOT EDIT, for system use only. Leave blank when adding new TFL rows. -
Column B
Status: DO NOT EDIT, for system use only. Leave blank when adding new TFL rows. -
Column C
Class: Required. The TFL Class (e.g. Safety, Efficacy). Must be a value defined in the TFL Class drop down list in Candid. These values are provided as a drop down menu in the worksheet (unless modified by a user). -
Column D
Type: Required. The TFL Type (e.g. Table, Figure, Listing). Must be a value defined in the TFL Type drop down list in Candid. These values are provided as a drop down menu in the worksheet (unless modified by a user). -
Column E
Name: Required. The TFL name. -
Column F
Number: Optional. The TFL number (e.g. 12.0.0.101). -
Column G
Sort Order: Required to be at least 0 if not used for sorting. Example valid values: 0, 1, 1.1, 1.01, 1.001. -
Column H
Group: Optional. Identify the Group name (e.g. Top-line). Must be a value defined in the TFL Group drop down list in Candid. These values are provided as a drop down menu in the worksheet (unless modified by a user). -
Column I
Program: Optional. The name of the SAS program used to produce the TFL. -
Column J
Default Test Program: Optional. If Column G (Program) is populated with a value, then this will be auto-populated with your configured default Test Program pattern (e.g. v-{value from column G}) (entering a different value will override). -
Column K
Default Test Method: Optional. If Column I (Default Test Method) is left blank it will auto-populate with the your configured Test Method tagged as the default (e.g. Independent Programming) (you can select a different value to override). -
Column L
Initial Instructions: Optional. Most common use case is to allow a Statistician to enter special instructions for producing this TFL. -
Column N
Title 1: Optional. The value for the first title. Title counting in Candid is 1-based. The first title is most often the same across TFLs (e.g 'Our Company - Protocol #XYZ'). -
Columns P-AB
Titles 2-8 Optional. -
Column AD
Footnote 1: Optional: The value for the first footnote. Footnote counting is 1-based. ` -
Columns AF-AV
Footnotes 2-10: Optional. -
Column AX
SourceData: Optional. Will always be the last footnote in (n) footnotes. Typically denotes the source dataset for the TFL. -
Columns AZ - BJ
Programmer1, Programmer2, Tester1, Tester2, Statistician1, Statistician2: Optional. Represents assigned Programmers, Testers, and Statisticians. Must select from the drop down lists which are provided during export and can be found on the Information tab. These lists are made up of the Statisticians and Programmers listed on the Analysis team at the time of export. Names in these fields that do not match an analysis team member will not be added. A single name cannot be assigned to more than one role.