Implement tests & Doc fixes #84
Conversation
init tests with a test for the get_info function
added some more docs; fixed an issue with the docstrings of multiple functions
src/io.jl
Outdated
| lazy (Bool::false): Do not actually load the dataset into memore if true, only return a dataframe with paths | ||
|
|
||
| generate_Xs (Bool::true): Do not recreate the designmatrix; improves loading time. |
There was a problem hiding this comment.
I think here, and with all other keywords, you should put them into ` backticks, so that e.g. generate_Xs the underscore is not recognized as a "beginning of italic"
This is a todo for all docustrings
src/load.jl
Outdated
| specificFolder (Union{Nothing,AbstractString}::nothing): Specify a specific folder name in either derivatives or bids_root to look for data. | ||
|
|
||
| excludeFolder (Union{Nothing,AbstractString}::nothing): Exclude a specific folder from data detection. |
There was a problem hiding this comment.
inconsistency with camelCase under_score.
We kind of settled to exclude_folder rather than camelcase. This makes changes necessary pretty much everywhere and will be breaking (but not many people use it yet, so I think shold be fine)
src/load.jl
Outdated
|
|
||
| # get subject and file information | ||
| function get_info!(files_df, file) | ||
| function get_info!(files_df, file) |
There was a problem hiding this comment.
maybe rename to better fit it's purpose?
get/extract_subjectid or something?
|
I have not looked at the tests yet & havent checked the documention. The docs preview is not yet rendered on github right? at least https://unfoldtoolbox.github.io/UnfoldBIDS.jl/previews/PR84 this doesnt exist. We do that in UnfoldSim, UnfoldMakie and maybe others. have a look at their |
Co-authored-by: Benedikt Ehinger <[email protected]>
|
Everything should be addressed now Haven't tried the docs preview yet, though. |
|
https://unfoldtoolbox.github.io/UnfoldBIDS.jl/previews/PR84/
I like it! It is right now a small package, but can grow to something super useful. well done :) |
tests now look out for an error/ warning in run_unfold. This should give security on future breaking changes with Unfold.jl; the docfix hopefully fixes the CI issue with the Artifact
Implements some tests and fixes the documentation a bit
@behinger can you review?