Skip to content

Commit 7fedea6

Browse files
typos and clarity
1 parent 72fe400 commit 7fedea6

2 files changed

Lines changed: 11 additions & 9 deletions

File tree

README.md

Lines changed: 10 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,15 @@ Here, you can find the methods we use for collecting data to validate our biomet
77

88
## Versioning Structure
99

10-
All tests have their own version. The structure for their version follows this pattern: ```X.Y.Z```
10+
All tests have their own version that can and does vary independently of other tests. The structure for their version follows this pattern: ```X.Y.Z```
1111

1212
The number in the ```X``` position denotes a change in the test that makes it [incompatible](#definition-of-compatibilitiy) with data collected using that test with a different ```X``` version. For example, version ```1.4.2``` is [compatible](#definition-of-compatibilitiy) with version ```1.6.1```, but not [compatible](#definition-of-compatibilitiy) with version ```0.2.5``` or version ```2.9.1```.
1313

14-
The number in the ```Y``` position denotes a change to the test that was only made to support another device. The test structue has not change, it has just had modifications made to indicate how to use another device with the test. Tests with different ```Y``` versions are still [compatible](#definition-of-compatibilitiy) with each other as long as they have the same ```X``` version. For example, version ```1.2.4``` is [compatible](#definition-of-compatibilitiy) with version ```1.3.4``` but not with version ```2.2.4```.
14+
The number in the ```Y``` position denotes a change to the test that was only made to support another device. The test structure has not changed, it has just had modifications made to indicate how to use another device with the test. Tests with different ```Y``` versions are still [compatible](#definition-of-compatibilitiy) with each other as long as they have the same ```X``` version. For example, version ```1.2.4``` is [compatible](#definition-of-compatibilitiy) with version ```1.3.4``` but not with version ```2.2.4```.
1515

16-
The number in the ```Z``` position denotes a change that does not have any affect on the testing procedure, such as changing a typo or updating a screenshot in the test procedure. Tests with different ```Z``` version are still [compatible](#definition-of-compatibilitiy) with each other as long as they have the same ```X``` version. For example, version ```1.2.3``` is [compatible](#definition-of-compatibilitiy) with version ```1.2.4``` and version ```1.3.2``` but not with version ```2.2.3```.
16+
The number in the ```Z``` position denotes a change that does not have any affect on the testing procedure, such as fixing a typo or updating a screenshot in the test procedure. Tests with different ```Z``` versions are still [compatible](#definition-of-compatibilitiy) with each other as long as they have the same ```X``` version. For example, version ```1.2.3``` is [compatible](#definition-of-compatibilitiy) with version ```1.2.4``` and version ```1.3.2``` but not with version ```2.2.3```.
1717

18-
Any changes that one thinks are in the "gray area" are immediately considered an incompatible change.
18+
Any changes that are in the "gray area" are immediately considered an incompatible change.
1919

2020
For more information on the philosophy behind this versioning structure, see [semantic versioning.](https://semver.org/spec/v2.0.0.html)
2121

@@ -27,12 +27,14 @@ If two tests are compatible it does not mean that the data from these tests is t
2727

2828
If two tests are compatible it means that if you compare scores between the tests, it is a valid comparison.
2929

30+
In order to generate a score between two files, they need to explicitly be the same recording, which by definition requires that they were both recorded on the same version.
31+
3032
For example, if you have the following data:
31-
- (1) An EmotiBit and Cyton file recorded with ```v1.2.4```
32-
- (2) An EmotiBit and BrainFlow file recorded with ```v1.3.5```
33-
- (3) An EmotiBit and Cyton file recorded with ```v2.2.1```
33+
- (1) An EmotiBit and a Cyton file recorded with ```v1.2.4```
34+
- (2) An EmotiBit and aBrainFlow file recorded with ```v1.3.5```
35+
- (3) An EmotiBit and a Cyton file recorded with ```v2.2.1```
3436

35-
The files in (1) can be directly compared with each other and a score can be generated, as they are the same recording, just on two different devices, the same applies for (2) and (3).
37+
The files in (1) can be directly compared with each other and a score can be generated between the two files, as they are the same recording, just on two different devices, the same applies for (2) and (3).
3638

3739
In addition, you can compare the score generated in (1) to the score generated in (2), and it will be a valid comparison, but you cannot compare either (1) or (2) to (3).
3840

tests/README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
## Tests
2-
This directory contains all of the current tests.
2+
This directory contains all of the current tests. Each test is contained with its own text file. The description of a test contains its name, version, purpose, and directions for completion. There should only be one test per file.
33

44
## Tapping Procedure
55
All of the tests indicate to perform the tapping procedure. The tapping procedure is used to be able to effectively line up the data streams from the devices that you are using. This section describes how to correctly perform the tapping procedure:

0 commit comments

Comments
 (0)