[DOC] Reporting documentation #465

javiergcas · 2019-11-14T22:18:42Z

Closes None.

Changes proposed in this pull request:

First draft of documentation for reports
Figures described
Interaction description missing

…ports

enh:initial commit of dynamic plots

codecov · 2019-11-14T22:26:59Z

Codecov Report

Merging #465 into master will not change coverage.
The diff coverage is n/a.

@@           Coverage Diff           @@
##           master     #465   +/-   ##
=======================================
  Coverage   93.53%   93.53%           
=======================================
  Files          26       26           
  Lines        1965     1965           
=======================================
  Hits         1838     1838           
  Misses        127      127

Continue to review full report at Codecov.

Legend - Click here to learn more
Δ = absolute <relative> (impact), ø = not affected, ? = missing data
Powered by Codecov. Last update 5f64cbc...252f7c3. Read the comment docs.

jbteves

Only reviewed docs instead of code since I'm not familiar with the python-JS cross-talk employed with this PR.

docs/reporting.rst

jbteves · 2020-10-15T17:13:55Z

docs/reporting.rst

+-------------------------
+This view provides detailed information about an individual 
+component (selected in the summary view, see below). It includes three different
+interactive plots.


So should we just not list the plot as interactive?

requirements.txt

Co-authored-by: Joshua Teves <[email protected]>

eurunuela · 2020-10-16T08:09:19Z

Only reviewed docs instead of code since I'm not familiar with the python-JS cross-talk employed with this PR.

Thank you so much for the review @jbteves !

I'm not sure I understand what you mean by this though: "So should we just not list the plot as interactive?"

I added a link to the OHBM demo to the very top of the reporting page, so people can play around with it. The images in the docs are all static.

emdupre

Thanks again, @eurunuela and @javiergcas ! I think this will be a huge help to users.

I've made a few comments / suggestions to bring the docs in line with the current reporting functionality.

docs/reporting.rst

emdupre · 2020-10-16T13:36:33Z

docs/reporting.rst

+The image below shows a representative report, which has two sections: a) the summary view,
+and b) the individual component view.
+
+.. image:: /_static/rep01_overallview.png


I don't think this reflects the state of the reports any more, unfortunately, since we removed the individual component view. The figure should be updated

1b59407 should take care of this.

I included the individual component view section in the end, as we do show a static view of individual components.

That looks right, thanks !! Should we note that the individual component view will be empty by default, since no component is pre-selected ?

emdupre · 2020-10-16T13:39:08Z

docs/reporting.rst

+
+* **Kappa Scree Plot:** This scree plots provides a view of the components ranked by `Kappa`
+  As in the previous plot, each dot represents a component. The color of the dot inform us
+  about classification status. In this plot, size is not related to variance explained.


Should we explain what the axes are ?

docs/reporting.rst

emdupre · 2020-10-16T13:42:13Z

docs/reporting.rst

+=========================
+
+As previously mentioned, all plots in the report allow user interactions. The list of permitted
+interactions vary by plot, but can be easily infered by the toolbar that accompanies each plot


In the current view, the toolbar is only on the Kappa-Rho plot, so we likely need to rephrase this section accordingly.

1b59407 should take care of this.

Co-authored-by: Elizabeth DuPre <[email protected]>

emdupre · 2020-10-18T21:42:10Z

docs/reporting.rst

+  :align: center
+  :height: 150px
+
+.. note::


This is what I was thinking of 😸 Maybe let's move it up around L19 ?

Yes! That's a great idea. Thank you!

emdupre

One small suggestion from me, and I think this looks great. Thanks again !

jbteves

Found a few typos, but otherwise looks good with the continuous-docs render.

docs/reporting.rst

Co-authored-by: Joshua Teves <[email protected]>

eurunuela · 2020-10-19T14:17:43Z

Found a few typos, but otherwise looks good with the continuous-docs render.

Thank you! I thought I had already corrected those.

jbteves

LGTM, thanks @eurunuela and @javiergcas !

emdupre

LGTM ! 🚀 Merging now. Thanks again !!

smoia and others added 28 commits November 11, 2019 09:55

Added html template for report

58a2c32

doc: initial commit of reporting template

b61fb1e

doc: save out html for testing

34c9133

fix: add missing bokeh js script

fcaf13b

fix: unescape HTML ugly way

942a469

fix: add missing cdn's

b7262ab

enh: switch to generate_report structure

fbb2659

sty: switch back to pure CSS from bootstrap

31bf94f

fix: differently update template for content

f0db0f5

sty: add jupyter notebooks to git ignore

1901196

enh:initial commit of dynamic plots

2bffccf

fix: patch unpaired bracket

1627b10

Merge remote-tracking branch 'emdupre/doc/me-reports' into dynamic_re…

89fd655

…ports

enh:modularized dynamic kappa/rho plots

8bf5310

enh:docstrings added to KappaRho_DynPlot.py

0b44fa0

Force figures default, fold viz into reporting module

70bbe10

enh:TS and Spectrum are now dynamic plots

d834b30

Merge pull request ME-ICA#20 from javiergcas/dynamic_reports

27f7ac8

enh:initial commit of dynamic plots

sty: initial refactor of dynamic figures

ebea3c9

fix: re-introduce func to load comp_table

5ff0d3d

sty: finalize rough refactor

ed44834

fix: patch linting errors

7302e1e

Merge remote-tracking branch 'upstream/master' into doc/me-reports

d82e284

Initial commit of documentation page for reports

c9f1396

subsections added

84cdee1

doc:plot descriptions completed. new figures.

b496dee

doc: continue refactor

ef318b6

doc:additional info and pics of icons

41f6d0a

emdupre changed the title ~~Reports doc~~ [DOC] Reporting documentation Nov 14, 2019

jbteves requested changes Oct 15, 2020

View reviewed changes

eurunuela and others added 3 commits October 16, 2020 09:57

Update docs/reporting.rst

91a9f61

Co-authored-by: Joshua Teves <[email protected]>

Update docs/reporting.rst

47d2c75

Co-authored-by: Joshua Teves <[email protected]>

Merge with upstream master

e99cea0

eurunuela requested review from jbteves and tsalo October 16, 2020 08:09

emdupre requested changes Oct 16, 2020

View reviewed changes

eurunuela and others added 6 commits October 16, 2020 16:03

Update docs/reporting.rst

605535d

Co-authored-by: Elizabeth DuPre <[email protected]>

Update docs/reporting.rst

78963cf

Co-authored-by: Elizabeth DuPre <[email protected]>

Update docs/reporting.rst

470799f

Co-authored-by: Elizabeth DuPre <[email protected]>

Update docs/reporting.rst

e9cbc54

Co-authored-by: Elizabeth DuPre <[email protected]>

Update reporting page figures and text

1b59407

Update beta map text

635405e

eurunuela requested a review from emdupre October 18, 2020 10:52

emdupre reviewed Oct 18, 2020

View reviewed changes

emdupre previously approved these changes Oct 18, 2020

View reviewed changes

jbteves requested changes Oct 19, 2020

View reviewed changes

docs/reporting.rst Outdated Show resolved Hide resolved

docs/reporting.rst Outdated Show resolved Hide resolved

docs/reporting.rst Outdated Show resolved Hide resolved

Update docs/reporting.rst

f3965af

Co-authored-by: Joshua Teves <[email protected]>

eurunuela dismissed emdupre’s stale review via f3965af October 19, 2020 14:16

eurunuela and others added 2 commits October 19, 2020 16:17

Update docs/reporting.rst

d72a5b8

Co-authored-by: Joshua Teves <[email protected]>

Update docs/reporting.rst

27a0652

Co-authored-by: Joshua Teves <[email protected]>

Move note higher up the page

252f7c3

eurunuela requested review from jbteves and emdupre October 19, 2020 14:22

jbteves approved these changes Oct 19, 2020

View reviewed changes

emdupre approved these changes Oct 19, 2020

View reviewed changes

emdupre merged commit 0eaa3ba into ME-ICA:master Oct 19, 2020

jbteves mentioned this pull request Feb 5, 2021

Post-release Newsletter for February 2021 #673

Closed

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

[DOC] Reporting documentation #465

[DOC] Reporting documentation #465

javiergcas commented Nov 14, 2019 •

edited by tsalo

Loading

codecov bot commented Nov 14, 2019 •

edited

Loading

jbteves left a comment

jbteves Oct 15, 2020

eurunuela commented Oct 16, 2020

emdupre left a comment

emdupre Oct 16, 2020

eurunuela Oct 18, 2020

emdupre Oct 18, 2020

emdupre Oct 16, 2020

emdupre Oct 16, 2020

eurunuela Oct 18, 2020

emdupre Oct 18, 2020

eurunuela Oct 19, 2020

emdupre left a comment

jbteves left a comment

eurunuela commented Oct 19, 2020

jbteves left a comment

emdupre left a comment

[DOC] Reporting documentation #465

[DOC] Reporting documentation #465

Conversation

javiergcas commented Nov 14, 2019 • edited by tsalo Loading

codecov bot commented Nov 14, 2019 • edited Loading

Codecov Report

jbteves left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

eurunuela commented Oct 16, 2020

emdupre left a comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

Choose a reason for hiding this comment

emdupre left a comment

Choose a reason for hiding this comment

jbteves left a comment

Choose a reason for hiding this comment

eurunuela commented Oct 19, 2020

jbteves left a comment

Choose a reason for hiding this comment

emdupre left a comment

Choose a reason for hiding this comment

javiergcas commented Nov 14, 2019 •

edited by tsalo

Loading

codecov bot commented Nov 14, 2019 •

edited

Loading