Creating custom reports

  • Published by Viedoc System 2022-10-18
  • Print

Introduction

The custom reports are written in the programming language R that generates report tables and plots based on CRF and operational data. The R program can be re-used from study to study and is uploaded in Viedoc Designer.

The visibility of the custom reports can be controlled by role, so that dedicated reports can be created for different roles, for example Monitor, Project Manager, or Sponsor. This means that the custom report can only consist of data existing within the scope of the current study and user role.

The data in the custom reports is updated with every data sync, just like any other report in Viedoc Reports.

R version

The current version of the R program is 4.0.4.

Downloading the package

A .zip package for creating custom reports is downloaded from the Settings menu, found in the upper right corner of Viedoc Reports. This package is only available for users with access to the Reports page.

By clicking Download data for custom reports, and following the instructions on the screen, the .zip package is downloaded to your computer.

The .zip package consists of the following files that are to be used as support when writing your custom reports:

edcData.rds

This file contains sample data from the study, including CRF data and operational data, such as queries, reviews, signature, database lock, timelapse, and so on.

params.rds

This file includes these items:

  • Date of download - the date and time at which the data was pulled from Viedoc to the Reports server
  • Study Name
  • Study Type
  • Study Level Data - expectedNumberOfScreenedSubjects, expectedNumberOfEnrolledSubjects, expectedDateOfCompleteEnrollment, totalNumberOfStudySites, totalNumberOfUniqueCountries
  • Site Level Data - siteNumber, siteCode, siteName, countryCode, country, timeZone, timezoneOffset, siteType, expectedNumberOfSubjectsScreened, expectedNumberOfSubjectsEnrolled, maximumNumberOfSubjectsScreened

The list of sites in the "Site Level Data" is based on the user’s access to the study.

SampleReportCode.R

This is a sample report with explanations of the report structure. The code is a sample to give an idea to the user on how to write a report code, its corresponding inputs, and the structure of the output. This file also contains a list of R packages available for the user.

utilityFunctions.R

This file contains various functions that can be used when writing the custom report.

When finished, the R file uploads in the Global design settings of Viedoc Designer. For more information, see Configuring Viedoc Reports. The custom report is then selectable for users with permissions to see it in Viedoc Reports.