Update README.md to specify bids_dir parameter in Streamlit example #72
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Specifies how streamlit should be ran, with a bids_dir argument being passed & notes a possible error regarding non-initialized bids_dir data whilst using Streamlit
|
Ah yes, great fix, thank you! |
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
This is a simple documentation-specific pull request for
README.md.Specifically, the further specification of how
Streamlitshould be run, with abids_dirargument being passed & notes a possible error regarding non-initializedbids_dirdata whilst usingStreamlit.Specifically, the following simple changes are proposed for
README.md:streamlit run src/b2aiprep/app/Dashboard.pyto
streamlit run src/b2aiprep/app/Dashboard.py [path to BIDS directory]Lastly, a note was added regarding a possible bug encountered whilst attempting to use
Streamlit:After the Streamlit dashboard opens, please wait for the BIDS data to be loaded while on the Dashboard page, as an error regarding a non-initialized bids_dir directory may pop up if the BIDS data has not been fully loaded.