Skip to content

Commit

Permalink
Fix the space case data type to datatype.
Browse files Browse the repository at this point in the history
  • Loading branch information
JoeZiminski committed Oct 4, 2023
1 parent 822653b commit 240fb59
Show file tree
Hide file tree
Showing 8 changed files with 11 additions and 11 deletions.
4 changes: 2 additions & 2 deletions datashuttle/command_line_interface.py
Original file line number Diff line number Diff line change
Expand Up @@ -613,7 +613,7 @@ def construct_parser():
nargs="+",
type=str,
required=False,
help="Optional: (str, single or multiple) (selection of data types, or 'all')",
help="Optional: (str, single or multiple) (selection of datatypes, or 'all')",
)
make_sub_folders_parser.add_argument(
"--datatype",
Expand Down Expand Up @@ -663,7 +663,7 @@ def construct_parser():
type=str,
nargs="+",
required=False,
help="Optional: (str, single or multiple) (selection of data types, or 'all') (default 'all')",
help="Optional: (str, single or multiple) (selection of datatypes, or 'all') (default 'all')",
)
upload_parser.add_argument(
"--dry-run",
Expand Down
2 changes: 1 addition & 1 deletion datashuttle/configs/canonical_configs.py
Original file line number Diff line number Diff line change
Expand Up @@ -153,7 +153,7 @@ def check_dict_values_raise_on_fail(config_dict: Configs) -> None:

if not any([config_dict[key] for key in get_datatypes()]):
utils.log_and_raise_error(
f"At least one data type must be True in "
f"At least one datatype must be True in "
f"configs, from: {' '.join(get_datatypes())}."
)

Expand Down
2 changes: 1 addition & 1 deletion datashuttle/configs/config_class.py
Original file line number Diff line number Diff line change
Expand Up @@ -308,7 +308,7 @@ def get_datatype_items(
self, datatype: Union[str, list]
) -> Union[ItemsView, zip]:
"""
Get the .items() structure of the data type, either all of
Get the .items() structure of the datatype, either all of
them (stored in self.datatype_folders) or as a single item.
"""
if isinstance(datatype, str):
Expand Down
2 changes: 1 addition & 1 deletion datashuttle/datashuttle.py
Original file line number Diff line number Diff line change
Expand Up @@ -313,7 +313,7 @@ def upload(
be prefixed with "sub-", or the prefix will be
automatically added. "@*@" can be used as a wildcard.
"all" will search for all sub-folders in the
data type folder to upload.
datatype folder to upload.
ses_names :
a session name / list of session names, similar to
sub_names but requiring a "ses-" prefix.
Expand Down
4 changes: 2 additions & 2 deletions datashuttle/utils/folders.py
Original file line number Diff line number Diff line change
Expand Up @@ -88,7 +88,7 @@ def make_datatype_folders(
Parameters
----------
datatype : data type (e.g. "behav", "all") to use. Use
datatype : datatype (e.g. "behav", "all") to use. Use
empty string ("") for none.
sub_or_ses_level_path : Full path to the subject
Expand Down Expand Up @@ -382,7 +382,7 @@ def search_for_wildcards(
return new_all_names


# Search Data Types
# Search Datatypes
# -----------------------------------------------------------------------------


Expand Down
4 changes: 2 additions & 2 deletions docs/source/pages/documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -159,7 +159,7 @@ When the `all` argument is used for `--datatype` (`-dt`), the folders created de
```


### Data Types Folders
### Datatype Folders

In [SWC-Blueprint](https://swc-blueprint.neuroinformatics.dev/specification.html), *datatypes* specify where acquired experimental data of currently supported types (`behav`, `ephys`, `funcimg` and `histology`) is stored. See the [*datatypes* section of the SWC-Blueprint for more details](https://swc-blueprint.neuroinformatics.dev/specification.html#datatype).

Expand All @@ -182,7 +182,7 @@ upload \

Will *upload* (from *local* to *central* ) _behavioural_ _sessions_ 5 and 6, collected at any date, for _subjects_ 1 to 3.

The keyword `all` can be input in place of a `-sub`, `-ses` or _datatype_ argument `-dt` to transfer all available subject, sessions or data types available. For example:
The keyword `all` can be input in place of a `-sub`, `-ses` or _datatype_ argument `-dt` to transfer all available subject, sessions or datatypes available. For example:

```
datashuttle \
Expand Down
2 changes: 1 addition & 1 deletion tests/tests_integration/test_make_folders.py
Original file line number Diff line number Diff line change
Expand Up @@ -246,7 +246,7 @@ def test_custom_folder_names(self, project):
def test_datatypes_subsection(self, project, files_to_test):
"""
Check that combinations of datatypes passed to make file folder
make the correct combination of data types.
make the correct combination of datatypes.
Note this will fail when new top level folders are added, and should be
updated.
Expand Down
2 changes: 1 addition & 1 deletion tests/tests_integration/test_ssh_file_transfer.py
Original file line number Diff line number Diff line change
Expand Up @@ -285,7 +285,7 @@ def make_pathtable_search_filter(self, sub_names, ses_names, datatype):
create the table of only transferred sub, ses and datatype.
Two arguments must be created, one of all sub / ses / datatypes
and the other of all non sub/ non ses / non data type
and the other of all non sub/ non ses / non datatype
folders. These must be handled separately as they are
mutually exclusive.
"""
Expand Down

0 comments on commit 240fb59

Please sign in to comment.