Skip to content

PLD-Progression Grouper - visualize and analyze the progression of Polycystic Liver Disease (PLD) through user-inputted clinical data

License

Notifications You must be signed in to change notification settings

halbritter-lab/pld-progression-grouper

Repository files navigation

PLD-Progression Grouper logo

PLD-Progression Grouper

Please explore the PLD-Progression Grouper app hosted on GitHub pages.

Introduction

"Polycystic Liver Disease (PLD) - Progression Grouper" is an interactive web application designed to assist in the prognostic assessment of Autosomal Dominant Polycystic Liver Disease (ADPLD) and PLD within the context of Autosomal Dominant Polycystic Kidney Disease (ADPKD). Based on two recents studies titled "Sex, genotype, and liver volume progression as risk of hospitalization determinants in autosomal dominant polycystic liver disease" and "Modelling polycystic liver disease progression using age-adjusted liver volumes and targeted mutational analysis" (PMID: 36246085), this tool aims to facilitate the visualization of disease progression and estimates the future risk of liver-related hospitalization in individuals with PLD.

PLD, characterized by numerous fluid-filled cysts arising from intrahepatic biliary epithelia, is a mostly genetic cholangiopathy with significant clinical heterogeneity. The application leverages data from a single-center and a multicenter study to introduce novel clinical endpoints, such as normalized age-adjusted total liver volume (nTLV) and PLD-related hospitalization, for prognostic risk stratification.

References

The principle of the "PLD-Progression Grouper" tool has been first published in 2022, highlighting its application in the study of PLD within the context of both Autosomal Dominant Polycystic Kidney Disease (ADPKD) and Autosomal Dominant Polycystic Liver Disease (ADPLD). This underscores the tool's relevance and adaptability for assessing PLD progression not only in isolated cases but also when it occurs in conjunction with ADPKD. For more details on the publication, see PMID:36246085.

Features

  • Data Input and Visualization: Users can input individual-specific data, including age and total liver volume, to visualize the normalized total liver volume (nTLV) on a chart.
  • Trend Analysis: The app plots two key trend lines based on the formulas derived from the study, offering visual insight into the progression groups as defined in the research.
  • Dynamic Interaction: Users can interactively plot new data points on the chart, assisting in the analysis of individual individual trajectories.
  • Download and Print Options: The application allows for downloading the plotted chart and printing the page for offline analysis and record-keeping.

Technical Overview

The application is built using Vue.js and Chart.js, ensuring a responsive and interactive user experience. The layout is designed with controls and input fields on the left and the chart on the right, facilitating ease of use and clear data presentation.

Webapp usage and application components

PLD-Progression Grouper application components description

  1. Application Header

    • (1a) Logo: Displays the logo of the PLD-Progression Grouper application.
    • (1b) Title: Shows the name of the application.
    • (1c) Version Tag: Indicates the current version of the application.
  2. User Input Area

    • (2a) ID Field: Where users can enter a unique identifier for the data point they are entering or analyzing.
    • (2b) Age Input: Users can input the age of the patient in years.
    • (2c) Total Liver Volume (TLV) Input: Users can input the total liver volume measured in milliliters.
  3. Computed Outputs

    • (3a) Normalized Total Liver Volume (nTLV): This field displays the calculated normalized total liver volume based on the input TLV.
    • (3b) Progression Group (PG) Indicator: Shows the progression group classification based on the computed nTLV and age.
  4. Action Buttons

    • (4a) Plot Point: Submits the entered data and plots the point on the graph.
    • (4b) Print Page: Allows the user to print the current page.
    • (4c) Download Plot: Enables the user to download the displayed plot as an image.
    • (4d) Save (JSON): Saves the current data table into a JSON file.
    • (4e) Load (JSON): Loads data from a selected JSON file and updates the table and plot accordingly.
    • (4f) Download (Excel): Exports the data table into an Excel spreadsheet.
  5. Chart Area

    • Displays a scatter plot graph illustrating the relationship between age and nTLV, with trend lines indicating progression thresholds.
  6. Progression Group Legend

    • (6a) PG3: Indicates rapid progression (greater than 6.6% per year).
    • (6b) PG2: Indicates moderate progression (between 3.3% and 6.6% per year).
    • (6c) PG1: Indicates slow progression (less than 3.3% per year).
  7. Documentation Link

    • Provides a link to the GitHub README for detailed documentation of the application and its methodologies.
  8. Citation Information

    • Contains bibliographic information to cite when using the application for research or publication purposes.
  9. Footer

    • (9a) Institution Logo: Shows the logo of the associated medical institution.
    • (9b) Funder Logo: Displays the logo of the funding organization.
  10. Data Table (not visible in the screenshot)

  • If present, this would display a table of all data points entered, including ID, age, TLV, nTLV, progression group, and an option to remove data points.

Each numbered item refers to a different component or section of the app. Users interact with these components to input data, receive computed outputs, manage the data points, and utilize the results for further analysis or documentation.

URL API Documentation

Overview

The PLD-Progression Grouper tool supports URL query parameters, allowing users to preset input fields directly through the URL. This feature enables easy sharing of specific configurations and faster access to the tool with predefined settings.

Query flags

The tool accepts the following query parameters:

  1. patientId: Sets the patient's ID.
  2. age: Sets the patient's age.
  3. tlv: Sets the Total Liver Volume (TLV) in milliliters.
  4. acknowledgeBanner: Sets the banner acknowledgement state. Accepts true or false.
  5. showFooter: Controls the visibility of the footer. Accepts true or false.
  6. showCitation: Toggles the display of citation information. Accepts true or false.
  7. showDocumentation: Determines if the documentation link is shown. Accepts true or false.
  8. showControls: Enables or disables the display of the user input controls. Accepts true or false.

Usage examples

Data Privacy and Storage

Local Data Storage

The PLD-Progression Grouper is designed to prioritize user privacy and data security:

  • Client-Side Data Storage: All data input into the application is stored locally on the user's device. No personal or sensitive data is sent to or stored on a server.
  • Data Security: By keeping data client-side, the risk of data breaches is minimized, ensuring user data remains private and secure.

Output Formats

Export Options

Users can export their data in various formats for ease of use and flexibility:

  • Excel (XLSX): For users who prefer spreadsheet analysis, data can be exported in Excel format.
  • JSON: Offering a more technical format, data can be saved as JSON files, which are ideal for further processing or integration with other applications.
  • PNG: The application allows users to download charts as PNG images, perfect for presentations or reports.

Progressive Web App (PWA) support

The PLD-Progression Grouper is also available as a Progressive Web App (PWA), providing a more integrated and efficient user experience. The PWA is compatible with most modern browsers on both desktop and mobile devices. For the best experience, ensure your browser is up to date.

Installing the PWA

  1. Access the Tool: Open the PLD-Progression Grouper in your web browser.
  2. Install Prompt: A prompt to "Add to Home Screen" will appear if you are using a compatible browser.
  3. Confirm Installation: Click the prompt to install the application on your device.
  4. Access from Home Screen: Once installed, the app can be accessed directly from your home screen, just like any other installed application.

Usage

  • Offline access: The PWA can be used offline, making it convenient for users without constant internet access.
  • Faster load times: As a PWA, the application loads faster, providing a smoother user experience.
  • Regular updates: The app will update automatically with the latest features and improvements when online.

Limitations and Relevance

While the tool is based on a large cohort study, it's important to acknowledge the limitations in generalizability due to the cohort size. The tool serves a research purpose, offering a new approach to understanding the progression of ADPLD and assisting in decision-making for individuals with PLD.

Contributions

This tool is an open-source project, and contributions are welcome. Whether it's feature enhancement, bug fixing, or improvements in the algorithm, your input is valuable.

Citation policy

Copyright and license

  • All code from this project is licensed under the "MIT No Attribution" (MIT-0) License. For more information, please refer to the License file.

Creators and contributors

Bernt Popp

Ria Schönauer

Dana Sierks

Jan Halbritter

Contact

If you have any questions, suggestions, or feedback, please feel free to contact us.