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

Add component selection documentation #84

Closed
emdupre opened this issue Jul 6, 2018 · 6 comments
Closed

Add component selection documentation #84

emdupre opened this issue Jul 6, 2018 · 6 comments
Labels
documentation issues related to improving documentation for the project
Milestone

Comments

@emdupre
Copy link
Member

emdupre commented Jul 6, 2018

It would be great to have more documentation on what component selection entails. This is only covered in a very general way at this point and could be enormously expanded.

As @jbpoline had suggested, it would be great at some point to have automatically generated jupyter notebooks (using sphinx-gallery), but to start with I'd love to have a break down of the kappa, rho calculations and how various points in the decision tree impact those metrics.

One other piece: I know @handwerkerd has some examples from his meica-reports -- this section could be a great place to include those, until we generate some of our own !

@emdupre emdupre added the documentation issues related to improving documentation for the project label Jul 6, 2018
@tsalo tsalo added this to the 0.1.0 milestone Jul 7, 2018
@emdupre
Copy link
Member Author

emdupre commented Jul 9, 2018

@jwe080, it'd be great to have your expertise here, too !

@jbteves
Copy link
Collaborator

jbteves commented Apr 20, 2019

Since the reorganization happening in #247 I think this issue should be paused.

@jbteves jbteves added the paused issues that are put on hold while other issues or PRs are handled label May 2, 2019
@jbteves jbteves removed the paused issues that are put on hold while other issues or PRs are handled label May 23, 2019
@jbteves
Copy link
Collaborator

jbteves commented May 23, 2019

With #262 merged I am unpausing this issue.

@jbteves
Copy link
Collaborator

jbteves commented May 23, 2019

In line with many of the other issues I've commented on, I think that we should come up with a discrete set of tasks to close this issue. From the above, I could envision something like the following:

  • Add kappa, rho calculations and decisions to readthedocs
  • (Optional) Generate jupyter notebooks

@jbteves
Copy link
Collaborator

jbteves commented Oct 29, 2019

Given the interest in rewriting the decision tree, it seems that this issue is likely going to be solved as new code is written and documented. I think this issue is on probation.

@stale
Copy link

stale bot commented Jan 27, 2020

This issue has been automatically marked as stale because it has not had recent activity. It will be closed if no further activity occurs. Thank you for your contributions to tedana:tada: !

@stale stale bot added the stale label Jan 27, 2020
@stale stale bot closed this as completed Feb 3, 2020
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation issues related to improving documentation for the project
Projects
None yet
Development

No branches or pull requests

3 participants