Update readme and structure

INT-NIT / BEP032tools

Software tools supporting the BIDS Extension Proposal (BEP) dedicated to adding support for electrophysiological data recorded in animal models (BEP032)

MIT License

3 stars 9 forks source link

Update readme and structure #122

Closed JuliaSprenger closed 2 years ago

coveralls commented 2 years ago

Pull Request Test Coverage Report for Build 1860706642

20 of 25 (80.0%) changed or added relevant lines in 4 files are covered.
No unchanged relevant lines lost coverage.
Overall coverage increased (+0.9%) to 72.089%

Changes Missing Coverage	Covered Lines	Changed/Added Lines	%
bep032tools/generator/BEP032Templater.py	0	1	0.0%
bep032tools/generator/BEP032Generator.py	16	20	80.0%
<!--	Total:	20	25	80.0%	-->

Totals
Change from base Build 1852056781:	0.9%
Covered Lines:	873
Relevant Lines:	1211

💛 - Coveralls

JuliaSprenger commented 2 years ago

@killianrochet So you tested the instructions in the Readme step-by-step on your machine? From installation to checking the availability of the CLI and the python code snippets?

killianrochet commented 2 years ago

Hi ! @JuliaSprenger , for the use of the BEP032Generator function when I pass it my data folder as a parameter, the function recreates a data folder in the one that already exists. On the other hand if I don't have a data folder the function stops and gives me an error.

JuliaSprenger commented 2 years ago

Hi @killianrochet That's a good catch and sounds like we should fix it. Since it's not related directly to the structural changes here, could you open a separate issue and try to address this in another PR? For the PR i would propose to start adding a test first that defines the expected behavior and then implement the fix.