Skip to content
Snippets Groups Projects
Commit 9f8f825f authored by Henrik tom Wörden's avatar Henrik tom Wörden
Browse files

MAINT: rename in readme

parent 479d9af8
No related branches found
No related tags found
No related merge requests found
...@@ -3,7 +3,7 @@ ...@@ -3,7 +3,7 @@
## Welcome ## Welcome
This is a module for the [CaosDB-Crawler](https://gitlab.com/caosdb/caosdb-crawler/) This is a module for the [LinkAhead-Crawler](https://gitlab.com/linkahead/linkahead-crawler/)
that can read folder structures that comply with the that can read folder structures that comply with the
[BIDS specification](https://bids-specification.readthedocs.io). [BIDS specification](https://bids-specification.readthedocs.io).
...@@ -16,9 +16,9 @@ setup this code. ...@@ -16,9 +16,9 @@ setup this code.
The BIDS Standard defines rules for how data is stored in files and how those The BIDS Standard defines rules for how data is stored in files and how those
(and directories) must be named. Those rules can be checked with the (and directories) must be named. Those rules can be checked with the
`bids-validator`. The current implementation of this cfood and the corresponding `bids-validator`. The current implementation of this cfood and the corresponding
[converter](https://gitlab.indiscale.com/caosdb/src/crawler-converters/bids-converter) [converter](https://gitlab.indiscale.com/linkahead/src/crawler-converters/bids-converter)
does the following: does the following:
- the `dataset_description.json` is parsed and translated to CaosDB Entities - the `dataset_description.json` is parsed and translated to LinkAhead Entities
- the key value pairs of folder and file names (e.g. "sub-<sub-label>") are - the key value pairs of folder and file names (e.g. "sub-<sub-label>") are
parsed and the stored in appropriate Records parsed and the stored in appropriate Records
- the contents of measurement folders such as 'eeg', 'func' or 'anat' are - the contents of measurement folders such as 'eeg', 'func' or 'anat' are
...@@ -42,20 +42,20 @@ does the following: ...@@ -42,20 +42,20 @@ does the following:
## Further Reading ## Further Reading
Please refer to the [official documentation](https://docs.indiscale.com/caosdb-crawler/) of the CaosDB-Crawler for more information. Please refer to the [official documentation](https://docs.indiscale.com/linkahead-crawler/) of the LinkAhead-Crawler for more information.
## Contributing ## Contributing
Thank you very much to all contributers—[past, present](https://gitlab.com/caosdb/caosdb/-/blob/dev/HUMANS.md), and prospective ones. Thank you very much to all contributers—[past, present](https://gitlab.com/linkahead/linkahead/-/blob/dev/HUMANS.md), and prospective ones.
### Code of Conduct ### Code of Conduct
By participating, you are expected to uphold our [Code of Conduct](https://gitlab.com/caosdb/caosdb/-/blob/dev/CODE_OF_CONDUCT.md). By participating, you are expected to uphold our [Code of Conduct](https://gitlab.com/linkahead/linkahead/-/blob/dev/CODE_OF_CONDUCT.md).
### How to Contribute ### How to Contribute
* You found a bug, have a question, or want to request a feature? Please * You found a bug, have a question, or want to request a feature? Please
[create an issue](https://gitlab.com/caosdb/TODO-fill-url). [create an issue](https://gitlab.com/linkahead/TODO-fill-url).
* You want to contribute code? * You want to contribute code?
* **Forking:** Please fork the repository and create a merge request in GitLab and choose this repository as * **Forking:** Please fork the repository and create a merge request in GitLab and choose this repository as
target. Make sure to select "Allow commits from members who can merge the target branch" under target. Make sure to select "Allow commits from members who can merge the target branch" under
...@@ -65,8 +65,8 @@ By participating, you are expected to uphold our [Code of Conduct](https://gitla ...@@ -65,8 +65,8 @@ By participating, you are expected to uphold our [Code of Conduct](https://gitla
using the `autopep8` tool (`autopep8 -i -r ./`). Please write your doc strings following the using the `autopep8` tool (`autopep8 -i -r ./`). Please write your doc strings following the
[NumpyDoc](https://numpydoc.readthedocs.io/en/latest/format.html) conventions. [NumpyDoc](https://numpydoc.readthedocs.io/en/latest/format.html) conventions.
* You can also contact us at **info (AT) caosdb.de** and join the * You can also contact us at **info (AT) caosdb.de** and join the
CaosDB community on LinkAhead community on
[#caosdb:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org). [#linkahead:matrix.org](https://matrix.to/#/!unwwlTfOznjEnMMXxf:matrix.org).
## License ## License
......
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Please register or to comment