modular/shell: Start reorganizing the shell material
[swc-modular-shell-hearing.git] / README.md
1 # Cochlear Implants
2
3 A cochlear implant is a small electronic device that is surgically
4 implanted in the inner ear to give deaf people a sense of
5 hearing. More than a quarter of a million people have them, but there
6 is still no widely-accepted benchmark to measure their effectiveness.
7 In order to establish a baseline for such a benchmark, our supervisor
8 got teenagers with CIs to listen to audio files on their computer and
9 report:
10
11 1.  the quietest sound they could hear
12 2.  the lowest and highest tones they could hear
13 3.  the narrowest range of frequencies they could discriminate
14
15 To participate, subjects attended our laboratory and one of our lab
16 techs played an audio sample, and recorded their data—when they first
17 heard the sound, or first heard a difference in the sound.  Each set
18 of test results were written out to a text file, one set per file.
19 Each participant has a unique subject ID, and a made-up subject name.
20 Each experiment has a unique experiment ID. The experiment has
21 collected 351 files so far.
22
23 The data is a bit of a mess! There are inconsistent file names, there
24 are extraneous `NOTES` files that we'd like to get rid of, and the
25 data is spread across many directories. We are going to use shell
26 commands to get this data into shape. By the end we would like to:
27
28 1.  Put all of the data into one directory called `alldata`
29
30 2.  Have all of the data files in there, and ensure that every file
31     has a `.txt` extension
32
33 3.  Get rid of the extraneous `NOTES` files
34
35 If we can get through this example in the available time, we will move
36 on to more advanced shell topics…