Skip to main content

Franklin Snippet Library

Learn how to use, manage, and configure the Snippet Library in Franklin

Support avatar
Written by Support
Updated this week

The Snippet Library in Franklin is a centralized space for managing reusable content across your organization. It streamlines case analysis by allowing you to easily insert standardized text into various workflows, ensuring consistency, efficiency, and quality across all your analyses.

What Can You Do with the Snippet Library?

  • Insert pre-defined snippets into interpretation fields using the “Add Snippet” button.

  • Search, browse, and select relevant snippets based on context

  • Organize snippets into folders and categories for easy access and management.

  • Customize snippets to align with your organization's specific workflows and guidelines.

Note:

The Snippet Library must be configured for your organization. To enable this feature, please contact our support team and provide the details of your snippets library as outlined in the table below.

How to Use the Snippet Library

Access the Library

  • The “Add Snippet” button appears in relevant rich-text fields (e.g., variant interpretation).

  • Click the button to open the snippet selection dropdown.

  • You’ll see only snippets relevant to the section you are working in, based on context.

Search & Filter

  • You can use the search bar to quickly find snippets by name, folder, or content.

  • Snippets are grouped into folders (if applicable) and sorted alphabetically.

  • You can also search by typing “#” followed by text from the name, folder, or content (e.g., #pathogenic).

Insert a Snippet

  • Select a snippet from the dropdown list.

  • The snippet content is inserted at the current cursor position in the text field.

  • You can edit the inserted text freely or add multiple snippets as needed.


Supplying Snippet Data for Your Organization

To configure your organization's Snippet Library, provide a CSV with the following details for each snippet:

Column

Description

Possible Values

Name

The title of the snippet shown in the dropdown list.

Free text

Folder

[Optional]

The grouping used for organizing snippets in the dropdown.

Free text

Snippet Type

The category that defines where the snippet will appear in Franklin.

SNP_INTERPRETATION, SV_INTERPRETATION

Snippet Subtype

[Optional]

A specific grouping related to where the snippet will be presented.

MISSENSE, NONSENSE, FRAMESHIFT, SPLICING, INDEL, DELETION, DUPLICATION

Description

[Optional]

A short description for internal use (not shown in the dropdown).

Free text

Content

The rich text content (supports HTML) that will be inserted into fields.

Free text

(For formatted text, use HTML)

Examples

Name

Folder

Snippet Type

Snippet Subtype

Description

Content

PVS1

Pathogenic Criteria

SNP_INTERPRETATION

NONSENSE

PVS1 rule for null variants

Null variant in a gene where loss of function is a known mechanism of disease.

BP4

Benign Criteria

SNP_INTERPRETATION

BP4 rule for benign predictions

Multiple computational algorithms predict no impact on the gene or gene product, supporting benign classification.

Heterozygous Deletion

Pathogenic CNVs

SV_INTERPRETATION

DELETION

CNV deletion in a dosage-sensitive gene

This heterozygous deletion impacts a dosage-sensitive gene associated with the patient's phenotype, supporting pathogenic classification.

Whole Gene Duplication

Likely Benign CNVs

SV_INTERPRETATION

DUPLICATION

CNV duplication without clinical significance

This duplication spans an entire gene not known to be dosage-sensitive and is considered likely benign.

BA1

Benign Criteria

SNP_INTERPRETATION

BA1 rule for high population frequency

<p>Variant observed at a frequency <strong>greater</strong> than expected for disorder, supporting benign classification (BA1).</p>

Did this answer your question?