search

mind-inria / hidimstat

HiDimStat: High-dimensional statistical inference tool for Python
https://mind-inria.github.io/hidimstat
BSD 2-Clause "Simplified" License
5 stars 4 forks source link

The examples #45

Open lionelkusch opened 9 hours ago

lionelkusch commented 9 hours ago

Actual statement of the example:

The actual template of the example is:

  1. Short description
  2. References
  3. Import function
  4. Import dataset
  5. Preprocessing
  6. Parametrization of the functions and processing
  7. Plotting result

However, Knockoff is not separated in different parts. The example "Support recovery on fMRI data" is dependant of the nilearn.

lionelkusch commented 9 hours ago

In my opinion, the short description at the beginning is too long; it should be at least one or two sentences. The meaning should be in the title. The explication should be along the example, not condensed at the beginning.

It is missing a visual description of the dataset (plot, data frame view, ...). It is missing a visual comparison of the different methods used or the method itself.

The last plot should have some explanation of what is shown. It's better to add all the references at the end of the notebook.

lionelkusch commented 9 hours ago

In general, it is missing basic examples of usage of the different methods and functions. It missing a very basic case of what it possible to do with this library.