BIAPT / awareness-perturbation-complexity-index

Development of an index for assessing the level of consciousness of healthy and disorder of consciousness individuals.
1 stars 0 forks source link

Refactor the documentation to sit in the code #15

Closed yacineMahdid closed 4 years ago

yacineMahdid commented 4 years ago

The documentation was in the wiki page of Github, I (yacine mahdid) decided to switch to an in-code documentation for two reasons:

  1. To not be tied to Github for documenting and reporting
  2. To be able to version control the documentation page

I'm open to other suggestions to document the code and the analysis, however due to the highly changing nature of the analysis it is difficult to keep the documentation up-to-date the further away from the code it lies.