Skip to content

LORIS Release v22.0.0
Compare
Choose a tag to compare
@ridz1208 ridz1208 released this 29 Nov 21:08
· 17 commits to 22.0-release since this release
v22.0.0
66f9ce2

This release contains user interface improvements, code clean up, bug fixes and new features. This release assigns users to projects, and begins the process of adding project-based permissions to LORIS in addition to the site-based permissions that already exist.

Full list of changes

Some of the major changes to this release are:

Summary

Features

  • New module: Imaging QC. Note this module requires an installed MRI Parameter Form instrument in order to load.
  • Addition of project affiliations to users. #5009
  • Addition of the project flag to timepoints and rename of the ProjectID column to RegistrationProjectID in the candidate table. #4919
  • Creation of script to modify configuration settings from the back-end. #4973
  • Addition of the ability to generate PSCIDs based on the project the candidate is affiliated with. #5285
  • Automatically populate PSCID, CandID & visit label based on the filename upon upload in the imaging uploader module #5306

Updates and Improvements

  • Paths in the configuration module will be validated before saving. Invalid paths will not be accepted. #4023
  • Adding the image_type header to the mri_protocol table to allow scan type discrimination based on that header. #4448
  • Improvement of the efficiency of DataTable filtering for large data tables. #5299
  • Hiding of the UI option allowing users to edit their own approval status. #5353
  • Addition of a new permission for "view only" in the data release module. #5557
  • Help text in most modules has been rewritten to be more user-friendly.

Bug Fixes

  • Fixes slash bug when including directory for endpoint in Module class. #5236
  • Addition of the -p flag to mkdir so that the install script won't fail when user_uploads/ already exists (for whatever reason) in document_repository or data_release module folders. #5245
  • Restoring possibility to read .nii.gz files with Brainbrowser. #5314
  • Addition of permissions to access Brainbrowser Module. #5530

Clean Up

  • Renaming SQL project_rel table to project_subproject_rel. #4492
  • Deletion of the full MINC header entry from parameter_file as not used anymore. #4925
  • Removal of the mri_acquisition_dates table of the database. #4962
  • Removal of unused functions in the Database.class.inc class. #4974
  • Removal of unused variables from imaging_uploader.class.inc. #5307
  • Renaming of the "Quality Control" module to "Imaging Quality Control". #5620
  • Renaming of the "Data Team Helper" module to "Behavioural Quality Control". #5620

Notes for Existing Projects

  • All paths in the Configuration module have to be valid (existing and writeable/readable on the file system) in order to be able to save a change in the module. #4023
  • Instruments are now loaded through a module in LORIS. The URL will thus now include a n/instruments/ element before the instrument name. Old links to instruments will no longer be valid. #4229
  • Modified the mri_protocol table to include image_type header information so that a scan can be identified based on that parameter along with the other acquisition parameters (particularly useful to distinguish between fieldmap magnitude and fieldmap phase images for example) #4448
  • A project selection is now mandatory when creating a timepoint. #4919
  • All users must now be affiliated to projects. Given the novelty of this feature, all users are automatically added to all projects by default. #5009
  • Some functions in the database class were removed since they are no longer being used. These removals might affect project code using said functions. #4974
  • NodeJS and NPM will have to be installed in order to upgrade to this version #5017
  • No need anymore to manually enter PSCID, CandID and Visit label in the upload form of the imaging uploader since they are not being automatically populated based on the filename upon upload #5306
  • The "Quality Control" module has been renamed to "Imaging Quality Control" and moved under the "Imaging" tab of the menu #5620
  • The "Data Team Helper" module has been renamed to "Behavioural Quality Control" and moved under the "Clinical" tab of the menu #5620
  • Projects now require an alias, the alias is used for PSCID generation. Upgrading LORIS will automatically add aliases to existing projects by using the first 4 characters from the project name. #5285

Upgrade process

Please note that in order for the steps below to succeed you must be on LORIS version 21.0.4. If you are on any previous version, the upgrade might fail to complete.

  1. Make sure you have installed "NodeJS" and "NPM" on your machine. These are new dependencies and must be installed in order to proceed with the upgrade.
  2. Get the latest release code (download and extract)
  3. Run make all from the LORIS root directory to update all dependencies
  4. Source the 21.0_To_22.0_upgrade.sql SQL file into your database.

Note: Some cleanup SQL commands might fail due to foreign key errors or other data related issues, make sure to test the release SQL patch previously and correct all necessary issues before proceeding to production.

Assets 2