redcap-embedded-pdf

Provides the @EMBEDDEDPDF action tag to REDCap

https://github.com/paigejulianne/redcap-embedded-pdf

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

✓
CITATION.cff file
Found CITATION.cff file
✓
codemeta.json file
Found codemeta.json file
✓
.zenodo.json file
Found .zenodo.json file
○
DOI references
○
Academic publication links
○
Academic email domains
○
Institutional organization owner
○
JOSS paper metadata
○
Scientific vocabulary similarity
Low similarity (12.0%) to scientific vocabulary

Keywords

redcap redcap-external-module redcap-repo

Last synced: 6 months ago · JSON representation ·

Repository

Provides the @EMBEDDEDPDF action tag to REDCap

Basic Info

Host: GitHub
Owner: paigejulianne
License: mit
Language: PHP
Default Branch: main
Homepage:
Size: 48.8 KB

Statistics

Stars: 1
Watchers: 2
Forks: 0
Open Issues: 0
Releases: 3

Topics

redcap redcap-external-module redcap-repo

Created over 2 years ago · Last pushed about 1 year ago

Metadata Files

Readme License Citation Codeowners

Embedded PDF External Module for REDCap

This module allows you to embed PDFs in the middle of your form using the action tag @EMBEDDEDPDF. This is useful for displaying PDFs that are needed for reviewing prior forms.

Installation

Enable the module through the Control Panel
Set the web path to your eDocs folder in the module configuration page

Usage

I've tried to make this as easy as possible. Simply add the action tag @EMBEDDEDPDF=event_name:form_name:instance to a Descriptive Text field and the module will do the rest.

The PDF will be appended to the text in the field, so you can add headers that will be shown before the PDF.

Where event_name is the name of the event or unique event ID (as assigned by REDCap), form_name is the name of the form, and instance is the instance number of the form.

For non-longitudinal projects, pass 0 as the event name.

You can also use the selected smart variables in place of the instance number: * [first-instance] * [last-instance] * [current-instance] * [previous-instance] * [all-instances] (same as passing no instance number or 0)

Example: @EMBEDDEDPDF=baseline_arm_1:demographics:[current-instance]

NOTE: If the form you are referencing is blank (contains no data), the module will not generate a PDF. IN ADDITION, the field will be completely hidden on the form.

It interoperates with other action tags.

Bug Reporting

Please report any bugs to the GitHub repository at https://github.com/metrc/redcap-embedded-pdf/issues

Author

Paige Julianne Sullivan
psullivan@jhu.edu
Major Extremity Trauma Research Consortium
Bloomberg School of Public Health
Johns Hopkins University

License

This project is licensed under the MIT License - see the LICENSE.md file for details

Acknowledgments

Thanks to the entire METRC team for their support and feedback, especially Anthony (Tony) Carlini who challenged me to write this module.

Owner

Name: Paige Julianne Sullivan
Login: paigejulianne
Kind: user
Location: Raleigh, NC USA
Company: @metrc

Website: https://paigejulianne.com
Repositories: 1
Profile: https://github.com/paigejulianne

Currently working at @metrc as the REDCap administrator and developer

Citation (CITATION.cff)

cff-version: 1.2.0
title: EMBEDDEDPDF Action Tag for REDCap
message: >-
  If you use this software, please cite it using the
  metadata from this file.
type: software
authors:
  - given-names: Paige
    family-names: Sullivan
    email: psullivan@jhu.edu
    affiliation: Johns Hopkins University
    orcid: 'https://orcid.org/0009-0002-7041-9547'
repository-code: 'https://github.com/metrc/redcap-embedded-pdf'
abstract: >-
  This is an external module for REDCap that adds the @EMBEDDEDPDF action tag,
  allowing you to embed a PDF of another form anywhere on the form.
keywords:
  - redcap
  - redcap-external-module
  - redcap-repo
license: MIT

ecosyste.ms

Data

Tools

Indexes

Applications

Experiments

Open Source Science