Skip to content

A REDCap External Module allowing some tweaking of the My Projects page.

License

Notifications You must be signed in to change notification settings

grezniczek/my_projects_tweaks

Repository files navigation

My Projects Tweaks

A REDCap External Module allowing some tweaking of the My Projects page.

Requirements

REDCAP 8.11.6 up to 10.0.1. REDCap 10.0.2 and newer had the features of this module integrated.

Installation

  • Clone this repo into <redcap-root>/modules/redcap_field_help_v<version-number>, or
  • Obtain this module from the Consortium REDCap Repo via the Control Center.
  • Go to Control Center > Technical / Developer Tools > External Modules and enable this module.
  • This module does not need to be enabled for any projects.

Configuration

A few system settings are available. There are no project-specific settings.

  • Debug mode: Check to have JavaScript snippets included as separate files. This may be useful for debugging in the browser developer tools.
  • Filter persistence: Persists the project filter value (via a cookie). This can be turned on and off by the users.
  • Add project PIDs: Adds a new PID column (in between Project Title and Records). For super users, the PIDs are links that lead to the Project's Settings page.
  • Link to Codebook: Adds Codebook links to the Fields column for all users.
  • Link to Record Status Dashboard: Add links to the Record Status Dashboard in the Records column.
  • Suppress description popups: Does just that. This can be finetuned by limitiing the effect to certain users only (whitelist) or to exclude certain users from the benefits of this effect (blacklist).
  • Replace description popups: When activated, the popups remain, but only trigger when the mouse hovers over the icons (which are now right-aligend). The popups also don't flicker and when clicked with the mouse, the corresponding project will be loaded. You don't like the colors? --> Submit a pull request that makes this configurable ;)
  • Collapse All: Adds a Collapse All button next to the Organize button that collapses all project folders.
  • Organize Projects filtering: Add a filter to the Organize Projects modal

A fix for the misaligned column headers in the My Projects table when folders are used is always active.

Testing

Instructions for testing the module can be found here.

Changelog

Version Updates
1.4.1 Change: Instead of linking to the Online Designer, which leads to Access Denied pages for most users, the Fields column now links to the Codebook. This is for all users.
1.4.0 New feature: Add a filter to the project list in the Organize Projects modal.
1.3.1 Bug fix: Fix collapse all.
1.3.0 New feature: Add a collapse all button that collapses all project folders.
1.2.1 Bug fixes: Set tooltip icon z-index; enable Record Status Dashboard links for all users.
Misc: Add instructions for testing the module.
1.2.0 New features: Persistence of project filter, links to the Record Status Dashboard (Records column), and to the Online Designer (Fields column; admins only).
1.1.1 Bug fix: When jQuery was missing, the module might cause blank pages.
1.1.0 Enhancement: For super users, the PIDs are now links to the Project's Settings page.
Update: REDCap 9.4.1 changed the tooltips on the my project page. This updated takes this into consideration.
1.0.2 Enhancement: The misalignment of headers in the My Projects table, which is present in vanilla REDCap when folders are used, gets fixed by this update. This effect is always on as long as this module is enabled.
1.0.1 Bug fixes: When using folders and adding the PID column, folder title rows were one column short. When using folders, the PID column would not honor folder colors.
Enhancements: Link to the modules GitHub page is included in its description.
1.0.0 Initial release.