Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

FIX: revamp Q'kay interface #17

Merged
merged 14 commits into from
Apr 30, 2024
Merged

FIX: revamp Q'kay interface #17

merged 14 commits into from
Apr 30, 2024

Conversation

celprov
Copy link
Collaborator

@celprov celprov commented Apr 23, 2024

enh: display informative error messages to the user
enh: verify that there is at least one HTML file in dataset, otherwise prevent dataset addition.
enh: remove IQMs section from MRIQC report
enh: improve the output log

fix: docker-compose so it takes into consideration .env
fix: make a more intuitive interface to add datasets
fix: do not write templates in the repo
fix: fix bugs related to adding new users
fix: improve visualization of inspection list
fix: remove unused imports, unused files, unused variables and variables that refer to absolute user-dependent path
fix: simplifies html report so it does not need the list + the list length as an input
fix: remove uninformative comments
fix: move out of the main functions related to anonymization, dealing with two folders as they don't seem ready for deployment
sty: ruff

Closes #21, #22, #23, #20

fix: remove useless comment
fix: display error message when user already exists and ask to reenter a new username
fix: modify the interface so that it displays a list of available folders under /datasets
fix: warn user if a dataset already exists
fix: warn user if the dataset does not contain html files
fix: improve visualization of inspection list
enh: add a check that at least one HTML file is present inside the dataset folder
enh: remove the IQMs section from the MRIQC report as we said in the preregistration that raters will not have access to the IQMs
fix: simplify the function to modify the MRIQC report, change its name so it reflects better the behavior inside and document it better
fix: do not write the individual subject templates in the repo. Pass the modified html content to render_template instead
fix: delete code related anonymizing the MRIQC report and dealing with html from two folders as this code is still in development. A separate branch will be dedicated to working on those features in the future.
enh: add debugging output to the log about assigning dataset name when
creating it
of dataset where the html files are not directly in the folder but in
some subfolders
fix: add more output to the log
@celprov celprov changed the title Fix/celines fix FIX: revamp Q'kay interface Apr 23, 2024
Copy link
Member

@esavary esavary left a comment

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Looks good to me! I've tested it locally, I think we can merge and proceed from there for future improvements.

import random

import numpy as np
import os.path as op
Copy link
Member

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we should transition to Pathlib instead of os and glob, but it's better to address this in a future PR.

Copy link
Collaborator Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Good point!

@celprov
Copy link
Collaborator Author

celprov commented Apr 30, 2024

Actually, I don't have the rights to merge this PR, so feel free to do so.

@esavary
Copy link
Member

esavary commented Apr 30, 2024

Actually, I don't have the rights to merge this PR, so feel free to do so.

Indeed, sorry about that! Now it should be okay for future PRs. I've updated your access rights.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

Set name of dataset from dataset_description.json
2 participants