soberlab / ContinuousMIEstimation

Holmes-Nemenman modified KSG continuous entropy estimator
GNU General Public License v3.0
1 stars 1 forks source link

use directory structure from this paper? #10

Open NickleDave opened 5 years ago

NickleDave commented 5 years ago

Hey @neuRowsATL and @bark-rach I promise not to get chatty on your repos but I just wanted to suggest maybe having a directory structure like in this paper? https://journals.plos.org/ploscompbiol/article?id=10.1371/journal.pcbi.1005510 You'd have to give it a quick skim to get their reasoning, but basically they propose this, which I like because it doesn't overwhelm someone at first glance and makes it obvious what each pile of files is for:

Box 3. Project layout
.
|-- CITATION
|-- README
|-- LICENSE
|-- requirements.txt
|-- data
|  |-- birds_count_table.csv
|-- doc
|  |-- notebook.md
|  |-- manuscript.md
|  |-- changelog.txt
|-- results
|  |-- summarized_results.csv
|-- src
|  |-- sightings_analysis.py
|  |-- runall.py
neuRowsATL commented 5 years ago

9