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

[ENH] Strip reportlets out of full report #867

Merged
merged 7 commits into from
Dec 3, 2017

Conversation

oesteban
Copy link
Member

@oesteban oesteban commented Dec 1, 2017

A first stab at #478. Requires nipreps/niworkflows#210 to be merged in first

The stripped svgs are stored in:

fmriprep/
 |- sub-01/
 |   |- anat/
 |   |- func/ 
 |   \- figures/
 |       \- *.svg  <------- HERE
 \- sub-01.html

we can move it if you think that is not right.

@oesteban oesteban changed the title [ENH] Strip reportlets out of full report [ENH/WIP] Strip reportlets out of full report Dec 1, 2017
@effigies
Copy link
Member

effigies commented Dec 1, 2017

Maybe figures/ or fig/? Just to give a description besides the file type.

@@ -45,6 +45,23 @@ ds005/out/fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_bold_space-MN
ds005/out/fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_bold_space-MNI152NLin2009cAsym_preproc.nii.gz
ds005/out/fmriprep/sub-01/func/sub-01_task-mixedgamblestask_run-02_bold_space-MNI152NLin2009cAsym_variant-smoothAROMAnonaggr_preproc.nii.gz
ds005/out/fmriprep/sub-01.html
ds005/out/fmriprep/sub-01/figures
ds005/out/fmriprep/sub-01/figures/_scratch_reportlets_fmriprep_sub-01_anat_sub-01_T1w_reconall.svg
Copy link
Member

Choose a reason for hiding this comment

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

Can we drop the _scratch_reportlets_fmriprep_?

Also, if this is going to be a derivative, I think it makes sense to apply some naming conventions that can eventually be standardized. For instance, perhaps the type can be _{static,anim}.svg indicating whether it's a static or animated image. Here are some examples, but feel free to reject any that you don't like.

Structural:

  • reconall.svg -> surfaceoutline_static.svg
  • t1_2_mni.svg -> normalization_anim.svg
  • t1_seg.svg -> segmentation_static.svg
  • t1_skull_strip.svg -> skullstrip_static.svg

Functional:

  • acompcor.svg -> acompcor_static.svg
  • bbr.svg -> registration_anim.svg
  • bold_mask.svg -> skullstrip_static.svg
  • syn_sdc.svg -> synsdc_anim.svg
  • tcompcor.svg -> tcompcor_static.svg

Copy link
Member Author

Choose a reason for hiding this comment

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

I totally agree with all of this. Would it be fine with you if we leave this comment for the next iteration over #478 ? Just to make all these changes more iteratively, and risk less to breaking reports.

Copy link
Member

Choose a reason for hiding this comment

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

Missed this, sorry. Sure.

@oesteban oesteban changed the title [ENH/WIP] Strip reportlets out of full report [ENH] Strip reportlets out of full report Dec 3, 2017
@oesteban oesteban merged commit 348e862 into nipreps:master Dec 3, 2017
@oesteban oesteban deleted the fix/478-strip-svgs-from-reports branch December 3, 2017 17:16
@oesteban oesteban mentioned this pull request Dec 4, 2017
2 tasks
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.

2 participants