Skip to content

Commit 91039b7

Browse files
authored
Merge pull request #12 from justbennet/copyedit
Copyediting only.
2 parents 39a4b04 + edba05a commit 91039b7

File tree

1 file changed

+13
-13
lines changed

1 file changed

+13
-13
lines changed

README.md

Lines changed: 13 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -3,40 +3,40 @@ Every BIDS App needs to follow a minimal set of command arguments common across
33
all of the Apps. This allows users and developers to easily use and integrate
44
BIDS Apps with their environment.
55

6-
This is an minimalistic example BIDS App consisting of a Dockerfile and simple
7-
entrypoint script (written in this case in Python) accepting the standard BIDS
6+
This is a minimalist example of a BIDS App consisting of a Dockerfile and a simple
7+
entry point script (written in this case in Python) accepting the standard BIDS
88
Apps command line arguments. This repository can be used as a template for new BIDS Apps.
99

1010
For more information about the specification of BIDS Apps see [here](https://docs.google.com/document/d/1E1Wi5ONvOVVnGhj21S1bmJJ4kyHFT7tkxnV3C23sjIE/edit#).
1111

1212
### Description
13-
This is a placeholder for a shaort description explaining the user what your App is doing.
13+
This is a placeholder for a short description explaining to the user what your App will doing.
1414

1515
### Documentation
16-
Provide a link to a documention of your pipeline.
16+
Provide a link to the documention of your pipeline.
1717

1818
### How to report errors
19-
Provide instruction for users on how to get help and report errors.
19+
Provide instructions for users on how to get help and report errors.
2020

2121
### Acknowledgements
22-
Describe how would you like users to acknoledge the use of your App in their papers (citation, a paragraph that should be copy pasted etc.)
22+
Describe how would you would like users to acknowledge use of your App in their papers (citation, a paragraph that can be copy pasted, etc.)
2323

2424
### Usage
25-
This App has the following comman line arguments:
25+
This App has the following command line arguments:
2626

2727
usage: run.py [-h]
2828
[--participant_label PARTICIPANT_LABEL [PARTICIPANT_LABEL ...]]
2929
bids_dir output_dir {participant,group}
3030

31-
Example BIDS App entrypoint script.
31+
Example BIDS App entry point script.
3232

3333
positional arguments:
3434
bids_dir The directory with the input dataset formatted
3535
according to the BIDS standard.
3636
output_dir The directory where the output files should be stored.
37-
If you are running group level analysis this folder
37+
If you are running a group level analysis, this folder
3838
should be prepopulated with the results of
39-
theparticipant level analysis.
39+
the participant level analysis.
4040
{participant,group} Level of the analysis that will be performed. Multiple
4141
participant level analyses can be run independently
4242
(in parallel).
@@ -48,7 +48,7 @@ This App has the following comman line arguments:
4848
analyzed. The label corresponds to
4949
sub-<participant_label> from the BIDS spec (so it does
5050
not include "sub-"). If this parameter is not provided
51-
all subjects should be analyzed. Multiple participants
51+
all subjects will be analyzed. Multiple participants
5252
can be specified with a space separated list.
5353

5454
To run it in participant level mode (for one participant):
@@ -59,7 +59,7 @@ To run it in participant level mode (for one participant):
5959
bids/example \
6060
/bids_dataset /outputs participant --participant_label 01
6161

62-
After doing this for all subjects (potentially in parallel) the group level analysis
62+
After doing this for all subjects (potentially in parallel), the group level analysis
6363
can be run:
6464

6565
docker run -i --rm \
@@ -69,7 +69,7 @@ can be run:
6969
/bids_dataset /outputs group
7070

7171
### Special considerations
72-
Describe if your app has some special requirements. For example:
72+
Describe whether your app has any special requirements. For example:
7373

7474
- Multiple map reduce steps (participant, group, participant2, group2 etc.)
7575
- Unusual memory requirements

0 commit comments

Comments
 (0)