01-numpy.md 36.5 KB
Newer Older
1
---
2
title: Analyzing Patient Data
3
4
teaching: 60
exercises: 30
5
questions:
Greg Wilson's avatar
Greg Wilson committed
6
- "How can I process tabular data files in Python?"
7
objectives:
Brian Jackson's avatar
Brian Jackson committed
8
- "Explain what a library is and what libraries are used for."
9
- "Import a Python library and use the functions it contains."
10
11
12
13
- "Read tabular data from a file into a program."
- "Assign values to variables."
- "Select individual values and subsections from data."
- "Perform operations on arrays of data."
14
- "Plot simple graphs from data."
15
keypoints:
Greg Wilson's avatar
Greg Wilson committed
16
17
18
19
20
21
- "Import a library into a program using `import libraryname`."
- "Use the `numpy` library to work with arrays in Python."
- "Use `variable = value` to assign a value to a variable in order to record it in memory."
- "Variables are created on demand whenever a value is assigned to them."
- "Use `print(something)` to display the value of `something`."
- "The expression `array.shape` gives the shape of an array."
22
- "Use `array[x, y]` to select a single element from a 2D array."
Greg Wilson's avatar
Greg Wilson committed
23
- "Array indices start at 0, not 1."
Dustin Lang's avatar
Dustin Lang committed
24
- "Use `low:high` to specify a `slice` that includes the indices from `low` to `high-1`."
Greg Wilson's avatar
Greg Wilson committed
25
26
27
28
29
- "All the indexing and slicing that works on arrays also works on strings."
- "Use `# some kind of explanation` to add comments to programs."
- "Use `numpy.mean(array)`, `numpy.max(array)`, and `numpy.min(array)` to calculate simple statistics."
- "Use `numpy.mean(array, axis=0)` or `numpy.mean(array, axis=1)` to calculate statistics across the specified axis."
- "Use the `pyplot` library from `matplotlib` for creating simple visualizations."
30
31
---

32
In this lesson we will learn how to work with arthritis inflammation datasets in Python. However,
33
34
before we discuss how to deal with many data points, let's learn how to work with
single data values.
35

36
37
38
39
40
## Variables

Any Python interpreter can be used as a calculator:
~~~
3 + 5 * 4
Justin Pringle's avatar
Justin Pringle committed
41
~~~
42
{: .language-python}
Justin Pringle's avatar
Justin Pringle committed
43
~~~
44
45
46
23
~~~
{: .output}
47

48
49
50
51
52
This is great but not very interesting.
To do anything useful with data, we need to assign its value to a _variable_.
In Python, we can [assign]({{ page.root }}/reference/#assign) a value to a
[variable]({{ page.root }}/reference/#variable), using the equals sign `=`.
For example, to assign value `60` to a variable `weight_kg`, we would execute:
53

54
~~~
55
weight_kg = 60
Greg Wilson's avatar
Greg Wilson committed
56
~~~
57
{: .language-python}
58

59
60
61
62
63
From now on, whenever we use `weight_kg`, Python will substitute the value we assigned to
it. In essence, **a variable is just a name for a value**.

In Python, variable names:

64
65
 - can include letters, digits, and underscores
 - cannot start with a digit
66
67
68
69
70
71
72
 - are [case sensitive]({{ page.root }}/reference/#case-sensitive).

This means that, for example:
 - `weight0` is a valid variable name, whereas `0weight` is not
 - `weight` and `Weight` are different variables

## Types of data
73
Python knows various types of data. Three common ones are:
74
75
76
77
78

* integer numbers
* floating point numbers, and
* strings.

79
In the example above, variable `weight_kg` has an integer value of `60`.
80
81
82
83
84
85
86
87
88
89
90
91
92
To create a variable with a floating point value, we can execute:

~~~
weight_kg = 60.0
~~~
{: .language-python}

And to create a string we simply have to add single or double quotes around some text, for example:

~~~
weight_kg_text = 'weight in kilograms:'
~~~
{: .language-python}
93

94
## Using Variables in Python
95
To display the value of a variable to the screen in Python, we can use the `print` function:
96

97
~~~
98
print(weight_kg)
Greg Wilson's avatar
Greg Wilson committed
99
~~~
100
{: .language-python}
101
102

~~~
Tyler Reddy's avatar
Tyler Reddy committed
103
60.0
Greg Wilson's avatar
Greg Wilson committed
104
~~~
105
{: .output}
106

107
108
109
110
111
112
113
We can display multiple things at once using only one `print` command:

~~~
print(weight_kg_text, weight_kg)
~~~
{: .language-python}
~~~
Tyler Reddy's avatar
Tyler Reddy committed
114
weight in kilograms: 60.0
115
116
117
118
~~~
{: .output}

Moreover, we can do arithmetics with variables right inside the `print` function:
119

120
~~~
121
print('weight in pounds:', 2.2 * weight_kg)
Greg Wilson's avatar
Greg Wilson committed
122
~~~
123
{: .language-python}
124
125

~~~
126
weight in pounds: 132.0
Greg Wilson's avatar
Greg Wilson committed
127
~~~
128
{: .output}
129

130
131
132
133
134
The above command, however, did not change the value of `weight_kg`:
~~~
print(weight_kg)
~~~
{: .language-python}
jstapleton's avatar
jstapleton committed
135

136
~~~
Tyler Reddy's avatar
Tyler Reddy committed
137
60.0
138
139
140
~~~
{: .output}

141
142
To change the value of the `weight_kg` variable, we have to
**assign** `weight_kg` a new value using the equals `=` sign:
143

144
~~~
145
weight_kg = 65.0
146
print('weight in kilograms is now:', weight_kg)
Greg Wilson's avatar
Greg Wilson committed
147
~~~
148
{: .language-python}
149
150

~~~
151
weight in kilograms is now: 65.0
Greg Wilson's avatar
Greg Wilson committed
152
~~~
153
{: .output}
154

155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
> ## Variables as Sticky Notes
>
> A variable is analogous to a sticky note with a name written on it:
> assigning a value to a variable is like putting that sticky note on a particular value.
>
> ![Variables as Sticky Notes](../fig/python-sticky-note-variables-01.svg)
>
> This means that assigning a value to one variable does **not** change the values of other variables.
> For example, let's store the subject's weight in pounds in its own variable:
>
> ~~~
> # There are 2.2 pounds per kilogram
> weight_lb = 2.2 * weight_kg
> print(weight_kg_text, weight_kg, 'and in pounds:', weight_lb)
> ~~~
> {: .language-python}
>
> ~~~
> weight in kilograms: 65.0 and in pounds: 143.0
> ~~~
> {: .output}
>
> ![Creating Another Variable](../fig/python-sticky-note-variables-02.svg)
>
> Let's now change `weight_kg`:
>
> ~~~
> weight_kg = 100.0
> print('weight in kilograms is now:', weight_kg, 'and weight in pounds is still:', weight_lb)
> ~~~
> {: .language-python}
>
> ~~~
> weight in kilograms is now: 100.0 and weight in pounds is still: 143.0
> ~~~
> {: .output}
>
> ![Updating a Variable](../fig/python-sticky-note-variables-03.svg)
>
> Since `weight_lb` doesn't remember where its value came from,
> it isn't automatically updated when `weight_kg` changes.
{: .callout}
197
198


Benjamin Laken's avatar
Benjamin Laken committed
199

200
201
202
203
Words are useful, but what's more useful are the sentences and stories we build with them.
Similarly, while a lot of powerful, general tools are built into languages like Python,
specialized tools built up from these basic units live in
[libraries]({{ page.root }}/reference/#library)
devendra1810's avatar
devendra1810 committed
204
205
that can be called upon when needed.

206
207
208
209
210
211
## Loading data into Python
In order to load our inflammation data, we need to access
([import]({{ page.root }}/reference/#import) in Python terminology) a library called
[NumPy](http://docs.scipy.org/doc/numpy/ "NumPy Documentation").  In general you should use this
library if you want to do fancy things with numbers, especially if you have matrices or arrays.  We
can import NumPy using:
devendra1810's avatar
devendra1810 committed
212
213
214
215

~~~
import numpy
~~~
216
{: .language-python}
devendra1810's avatar
devendra1810 committed
217

218
219
220
221
222
223
Importing a library is like getting a piece of lab equipment out of a storage locker and setting it
up on the bench. Libraries provide additional functionality to the basic Python package, much like
a new piece of equipment adds functionality to a lab space. Just like in the lab, importing too
many libraries can sometimes complicate and slow down your programs - so we only import what we
need for each program. Once we've imported the library, we can ask the library to read our data
file for us:
devendra1810's avatar
devendra1810 committed
224
225
226
227

~~~
numpy.loadtxt(fname='inflammation-01.csv', delimiter=',')
~~~
228
{: .language-python}
devendra1810's avatar
devendra1810 committed
229
230
231
232
233
234
235
236
237
238
239
240

~~~
array([[ 0.,  0.,  1., ...,  3.,  0.,  0.],
       [ 0.,  1.,  2., ...,  1.,  0.,  1.],
       [ 0.,  1.,  1., ...,  2.,  1.,  1.],
       ...,
       [ 0.,  1.,  1., ...,  1.,  1.,  1.],
       [ 0.,  0.,  0., ...,  0.,  2.,  0.],
       [ 0.,  0.,  1., ...,  1.,  1.,  0.]])
~~~
{: .output}

Trevor Bekolay's avatar
Trevor Bekolay committed
241
The expression `numpy.loadtxt(...)` is a [function call]({{ page.root }}/reference/#function-call)
242
243
244
245
that asks Python to run the [function]({{ page.root }}/reference/#function) `loadtxt` which
belongs to the `numpy` library. This [dotted notation]({{ page.root }}/reference/#dotted-notation)
is used everywhere in Python: the thing that appears before the dot contains the thing that
appears after.
Brian Jackson's avatar
Brian Jackson committed
246

Tyler Reddy's avatar
Tyler Reddy committed
247
As an example, John Smith is the John that belongs to the Smith family.
248
We could use the dot notation to write his name `smith.john`,
Brian Jackson's avatar
Brian Jackson committed
249
just as `loadtxt` is a function that belongs to the `numpy` library.
devendra1810's avatar
devendra1810 committed
250

251
252
253
254
`numpy.loadtxt` has two [parameters]({{ page.root }}/reference/#parameter): the name of the file
we want to read and the [delimiter]({{ page.root }}/reference/#delimiter) that separates values on
a line. These both need to be character strings (or [strings]({{ page.root }}/reference/#string)
for short), so we put them in quotes.
devendra1810's avatar
devendra1810 committed
255
256
257
258
259
260
261
262
263
264
265
266

Since we haven't told it to do anything else with the function's output,
the notebook displays it.
In this case,
that output is the data we just loaded.
By default,
only a few rows and columns are shown
(with `...` to omit elements when displaying big arrays).
To save space,
Python displays numbers as `1.` instead of `1.0`
when there's nothing interesting after the decimal point.

Brian Jackson's avatar
Brian Jackson committed
267
Our call to `numpy.loadtxt` read our file
devendra1810's avatar
devendra1810 committed
268
269
but didn't save the data in memory.
To do that,
270
271
272
we need to assign the array to a variable. Just as we can assign a single value to a variable, we
can also assign an array of values to a variable using the same syntax.  Let's re-run
`numpy.loadtxt` and save the returned data:
273

274
~~~
Greg Wilson's avatar
Greg Wilson committed
275
276
data = numpy.loadtxt(fname='inflammation-01.csv', delimiter=',')
~~~
277
{: .language-python}
278

279
This statement doesn't produce any output because we've assigned the output to the variable `data`.
Brian Jackson's avatar
Brian Jackson committed
280
If we want to check that the data have been loaded,
281
we can print the variable's value:
282

283
~~~
284
print(data)
Greg Wilson's avatar
Greg Wilson committed
285
~~~
286
{: .language-python}
287
288

~~~
Greg Wilson's avatar
Greg Wilson committed
289
[[ 0.  0.  1. ...,  3.  0.  0.]
290
291
 [ 0.  1.  2. ...,  1.  0.  1.]
 [ 0.  1.  1. ...,  2.  1.  1.]
292
 ...,
293
294
295
 [ 0.  1.  1. ...,  1.  1.  1.]
 [ 0.  0.  0. ...,  0.  2.  0.]
 [ 0.  0.  1. ...,  1.  1.  0.]]
Greg Wilson's avatar
Greg Wilson committed
296
~~~
297
{: .output}
298

Brian Jackson's avatar
Brian Jackson committed
299
300
Now that the data are in memory,
we can manipulate them.
301
First,
302
let's ask what [type]({{ page.root }}/reference/#type) of thing `data` refers to:
303

304
~~~
305
print(type(data))
Greg Wilson's avatar
Greg Wilson committed
306
~~~
307
{: .language-python}
308
309

~~~
310
<class 'numpy.ndarray'>
Greg Wilson's avatar
Greg Wilson committed
311
~~~
312
{: .output}
313

314
The output tells us that `data` currently refers to
Brian Jackson's avatar
Brian Jackson committed
315
an N-dimensional array, the functionality for which is provided by the NumPy library.
316
These data correspond to arthritis patients' inflammation.
Brian Jackson's avatar
Brian Jackson committed
317
The rows are the individual patients, and the columns
318
319
are their daily inflammation measurements.

320
> ## Data Type
321
322
>
> A Numpy array contains one or more elements
Brian Jackson's avatar
Brian Jackson committed
323
324
325
326
> of the same type. The `type` function will only tell you that
> a variable is a NumPy array but won't tell you the type of
> thing inside the array.
> We can find out the type
327
328
> of the data contained in the NumPy array.
>
329
> ~~~
330
331
> print(data.dtype)
> ~~~
332
> {: .language-python}
333
334
>
> ~~~
335
336
> dtype('float64')
> ~~~
337
> {: .output}
338
339
>
> This tells us that the NumPy array's elements are
340
> [floating-point numbers]({{ page.root }}/reference/#floating-point number).
341
{: .callout}
342

Brian Jackson's avatar
Brian Jackson committed
343
With the following command, we can see the array's [shape]({{ page.root }}/reference/#shape):
344

345
~~~
346
print(data.shape)
Greg Wilson's avatar
Greg Wilson committed
347
~~~
348
{: .language-python}
349
350

~~~
Greg Wilson's avatar
Greg Wilson committed
351
352
(60, 40)
~~~
353
{: .output}
354

355
356
The output tells us that the `data` array variable contains 60 rows and 40 columns. When we
created the variable `data` to store our arthritis data, we didn't just create the array; we also
357
created information about the array, called [members]({{ page.root }}/reference/#member) or
358
359
360
361
attributes. This extra information describes `data` in the same way an adjective describes a noun.
`data.shape` is an attribute of `data` which describes the dimensions of `data`. We use the same
dotted notation for the attributes of variables that we use for the functions in libraries because
they have the same part-and-whole relationship.
362

363
364
365
366
If we want to get a single number from the array, we must provide an
[index]({{ page.root }}/reference/#index) in square brackets after the variable name, just as we
do in math when referring to an element of a matrix.  Our inflammation data has two dimensions, so
we will need to use two indices to refer to one specific value:
367

368
~~~
369
print('first value in data:', data[0, 0])
Greg Wilson's avatar
Greg Wilson committed
370
~~~
371
{: .language-python}
372
373

~~~
Greg Wilson's avatar
Greg Wilson committed
374
375
first value in data: 0.0
~~~
376
{: .output}
377

378
~~~
379
print('middle value in data:', data[30, 20])
Greg Wilson's avatar
Greg Wilson committed
380
~~~
381
{: .language-python}
382
383

~~~
Greg Wilson's avatar
Greg Wilson committed
384
385
middle value in data: 13.0
~~~
386
{: .output}
387

388
389
The expression `data[30, 20]` accesses the element at row 30, column 20. While this expression may
not surprise you,
390
 `data[0, 0]` might.
Brian Jackson's avatar
Brian Jackson committed
391
Programming languages like Fortran, MATLAB and R start counting at 1
392
393
because that's what human beings have done for thousands of years.
Languages in the C family (including C++, Java, Perl, and Python) count from 0
394
395
396
397
398
because it represents an offset from the first value in the array (the second
value is offset by one index from the first value). This is closer to the way
that computers represent arrays (if you are interested in the historical
reasons behind counting indices from zero, you can read
[Mike Hoye's blog post](http://exple.tive.org/blarg/2013/10/22/citation-needed/)).
399
As a result,
Greg Wilson's avatar
Greg Wilson committed
400
if we have an M×N array in Python,
401
402
403
404
405
406
its indices go from 0 to M-1 on the first axis
and 0 to N-1 on the second.
It takes a bit of getting used to,
but one way to remember the rule is that
the index is how many steps we have to take from the start to get the item we want.

407
408
![Zero Index](../fig/python-zero-index.png)

409
> ## In the Corner
410
411
412
413
>
> What may also surprise you is that when Python displays an array,
> it shows the element with index `[0, 0]` in the upper left corner
> rather than the lower left.
Brian Jackson's avatar
Brian Jackson committed
414
> This is consistent with the way mathematicians draw matrices
415
> but different from the Cartesian coordinates.
416
> The indices are (row, column) instead of (column, row) for the same reason,
417
> which can be confusing when plotting data.
418
{: .callout}
419

420
## Slicing data
421
422
423
424
An index like `[30, 20]` selects a single element of an array,
but we can select whole sections as well.
For example,
we can select the first ten days (columns) of values
425
for the first four patients (rows) like this:
426

427
~~~
428
print(data[0:4, 0:10])
Greg Wilson's avatar
Greg Wilson committed
429
~~~
430
{: .language-python}
431
432

~~~
Greg Wilson's avatar
Greg Wilson committed
433
[[ 0.  0.  1.  3.  1.  2.  4.  7.  8.  3.]
434
435
436
 [ 0.  1.  2.  1.  2.  1.  3.  2.  2.  6.]
 [ 0.  1.  1.  3.  3.  2.  6.  2.  5.  9.]
 [ 0.  0.  2.  0.  4.  2.  2.  1.  6.  7.]]
Greg Wilson's avatar
Greg Wilson committed
437
~~~
438
{: .output}
439

440
441
442
The [slice]({{ page.root }}/reference/#slice) `0:4` means, "Start at index 0 and go up to, but not
including, index 4."Again, the up-to-but-not-including takes a bit of getting used to, but the
rule is that the difference between the upper and lower bounds is the number of values in the slice.
443
444

We don't have to start slices at 0:
445

446
~~~
447
print(data[5:10, 0:10])
Greg Wilson's avatar
Greg Wilson committed
448
~~~
449
{: .language-python}
450
451

~~~
Greg Wilson's avatar
Greg Wilson committed
452
[[ 0.  0.  1.  2.  2.  4.  2.  1.  6.  4.]
453
454
455
456
 [ 0.  0.  2.  2.  4.  2.  2.  5.  5.  8.]
 [ 0.  0.  1.  2.  3.  1.  2.  3.  5.  3.]
 [ 0.  0.  0.  3.  1.  5.  6.  5.  5.  8.]
 [ 0.  1.  1.  2.  1.  3.  5.  3.  5.  8.]]
Greg Wilson's avatar
Greg Wilson committed
457
~~~
458
{: .output}
459

460
461
462
463
We also don't have to include the upper and lower bound on the slice.  If we don't include the lower
bound, Python uses 0 by default; if we don't include the upper, the slice runs to the end of the
axis, and if we don't include either (i.e., if we just use ':' on its own), the slice includes
everything:
464

465
~~~
Greg Wilson's avatar
Greg Wilson committed
466
small = data[:3, 36:]
467
468
print('small is:')
print(small)
Greg Wilson's avatar
Greg Wilson committed
469
~~~
470
{: .language-python}
Brian Jackson's avatar
Brian Jackson committed
471
The above example selects rows 0 through 2 and columns 36 through to the end of the array.
472
473

~~~
Greg Wilson's avatar
Greg Wilson committed
474
small is:
475
476
477
[[ 2.  3.  0.  0.]
 [ 1.  1.  0.  1.]
 [ 2.  2.  1.  1.]]
Greg Wilson's avatar
Greg Wilson committed
478
~~~
479
{: .output}
480

481
482
483
Arrays also know how to perform common mathematical operations on their values.  The simplest
operations with data are arithmetic: addition, subtraction, multiplication, and division.  When you
do such operations on arrays, the operation is done element-by-element.  Thus:
484

485
~~~
Greg Wilson's avatar
Greg Wilson committed
486
487
doubledata = data * 2.0
~~~
488
{: .language-python}
489

Greg Wilson's avatar
Greg Wilson committed
490
will create a new array `doubledata`
Tyler Reddy's avatar
Tyler Reddy committed
491
each element of which is twice the value of the corresponding element in `data`:
492

493
~~~
494
495
496
497
print('original:')
print(data[:3, 36:])
print('doubledata:')
print(doubledata[:3, 36:])
Greg Wilson's avatar
Greg Wilson committed
498
~~~
499
{: .language-python}
500
501

~~~
Greg Wilson's avatar
Greg Wilson committed
502
original:
503
504
505
506
507
508
509
[[ 2.  3.  0.  0.]
 [ 1.  1.  0.  1.]
 [ 2.  2.  1.  1.]]
doubledata:
[[ 4.  6.  0.  0.]
 [ 2.  2.  0.  2.]
 [ 4.  4.  2.  2.]]
Greg Wilson's avatar
Greg Wilson committed
510
~~~
511
{: .output}
512

513
514
515
If, instead of taking an array and doing arithmetic with a single value (as above), you did the
arithmetic operation with another array of the same shape, the operation will be done on
corresponding elements of the two arrays.  Thus:
516

517
~~~
Greg Wilson's avatar
Greg Wilson committed
518
519
tripledata = doubledata + data
~~~
520
{: .language-python}
521

522
523
524
will give you an array where `tripledata[0,0]` will equal `doubledata[0,0]` plus `data[0,0]`,
and so on for all other elements of the arrays.

525
~~~
526
527
print('tripledata:')
print(tripledata[:3, 36:])
Greg Wilson's avatar
Greg Wilson committed
528
~~~
529
{: .language-python}
530
531

~~~
Greg Wilson's avatar
Greg Wilson committed
532
tripledata:
533
534
535
[[ 6.  9.  0.  0.]
 [ 3.  3.  0.  3.]
 [ 6.  6.  3.  3.]]
Greg Wilson's avatar
Greg Wilson committed
536
~~~
537
{: .output}
538

539
540
541
Often, we want to do more than add, subtract, multiply, and divide array elements.  NumPy knows how
to do more complex operations, too.  If we want to find the average inflammation for all patients on
all days, for example, we can ask NumPy to compute `data`'s mean value:
542

543
~~~
544
print(numpy.mean(data))
Greg Wilson's avatar
Greg Wilson committed
545
~~~
546
{: .language-python}
547
548

~~~
Greg Wilson's avatar
Greg Wilson committed
549
550
6.14875
~~~
551
{: .output}
552

553
554
`mean` is a [function]({{ page.root }}/reference/#function) that takes
an array as an [argument]({{ page.root }}/reference/#argument).
555

556
> ## Not All Functions Have Input
557
558
559
>
> Generally, a function uses inputs to produce outputs.
> However, some functions produce outputs without
560
561
> needing any input. For example, checking the current time
> doesn't require any input.
562
>
563
> ~~~
564
565
> import time
> print(time.ctime())
566
> ~~~
567
> {: .language-python}
568
569
>
> ~~~
570
> 'Sat Mar 26 13:07:33 2016'
571
> ~~~
572
> {: .output}
573
574
575
576
>
> For functions that don't take in any arguments,
> we still need parentheses (`()`)
> to tell Python to go and do something for us.
577
{: .callout}
578
579
580

NumPy has lots of useful functions that take an array as input.
Let's use three of those functions to get some descriptive values about the dataset.
581
582
We'll also use multiple assignment,
a convenient Python feature that will enable us to do this all in one line.
583

584
~~~
585
maxval, minval, stdval = numpy.max(data), numpy.min(data), numpy.std(data)
586

Alistair Walsh's avatar
Alistair Walsh committed
587
588
589
print('maximum inflammation:', maxval)
print('minimum inflammation:', minval)
print('standard deviation:', stdval)
Greg Wilson's avatar
Greg Wilson committed
590
~~~
591
{: .language-python}
592
593
594
595

Here we've assigned the return value from `numpy.max(data)` to the variable `maxval`, the value
from `numpy.min(data)` to `minval`, and so on.

596
~~~
Greg Wilson's avatar
Greg Wilson committed
597
maximum inflammation: 20.0
598
599
minimum inflammation: 0.0
standard deviation: 4.61383319712
Greg Wilson's avatar
Greg Wilson committed
600
~~~
601
{: .output}
602

603
> ## Mystery Functions in IPython
604
>
605
> How did we know what functions NumPy has and how to use them?
Brian Jackson's avatar
Brian Jackson committed
606
> If you are working in the IPython/Jupyter Notebook, there is an easy way to find out.
Dustin Lang's avatar
Dustin Lang committed
607
> If you type the name of something followed by a dot, then you can use tab completion
608
> (e.g. type `numpy.` and then press tab)
Brian Jackson's avatar
Brian Jackson committed
609
610
> to see a list of all functions and attributes that you can use. After selecting one, you
> can also add a question mark (e.g. `numpy.cumprod?`), and IPython will return an
611
> explanation of the method! This is the same as doing `help(numpy.cumprod)`.
612
{: .callout}
613
614

When analyzing data, though,
Brian Jackson's avatar
Brian Jackson committed
615
616
617
we often want to look at variations in statistical values,
such as the maximum inflammation per patient
or the average inflammation per day.
618
One way to do this is to create a new temporary array of the data we want,
619
then ask it to do the calculation:
620

621
~~~
Dustin Lang's avatar
Dustin Lang committed
622
patient_0 = data[0, :] # 0 on the first axis (rows), everything on the second (columns)
623
print('maximum inflammation for patient 0:', patient_0.max())
Greg Wilson's avatar
Greg Wilson committed
624
~~~
625
{: .language-python}
626
627

~~~
Greg Wilson's avatar
Greg Wilson committed
628
629
maximum inflammation for patient 0: 18.0
~~~
630
{: .output}
631

632
Everything in a line of code following the '#' symbol is a
633
[comment]({{ page.root }}/reference/#comment) that is ignored by Python.
634
Comments allow programmers to leave explanatory notes for other
jstapleton's avatar
jstapleton committed
635
636
programmers or their future selves.

637
We don't actually need to store the row in a variable of its own.
638
Instead, we can combine the selection and the function call:
639

640
~~~
641
print('maximum inflammation for patient 2:', numpy.max(data[2, :]))
Greg Wilson's avatar
Greg Wilson committed
642
~~~
643
{: .language-python}
644
645

~~~
Greg Wilson's avatar
Greg Wilson committed
646
647
maximum inflammation for patient 2: 19.0
~~~
648
{: .output}
649

650
What if we need the maximum inflammation for each patient over all days (as in the
Brian Jackson's avatar
Brian Jackson committed
651
next diagram on the left) or the average for each day (as in the
652
653
diagram on the right)? As the diagram below shows, we want to perform the
operation across an axis:
654

655
![Operations Across Axes](../fig/python-operations-across-axes.png)
656

Brian Jackson's avatar
Brian Jackson committed
657
To support this functionality,
658
most array functions allow us to specify the axis we want to work on.
659
If we ask for the average across axis 0 (rows in our 2D example),
660
we get:
661

662
~~~
663
print(numpy.mean(data, axis=0))
Greg Wilson's avatar
Greg Wilson committed
664
~~~
665
{: .language-python}
666
667

~~~
Greg Wilson's avatar
Greg Wilson committed
668
[  0.           0.45         1.11666667   1.75         2.43333333   3.15
669
670
671
672
673
674
675
   3.8          3.88333333   5.23333333   5.51666667   5.95         5.9
   8.35         7.73333333   8.36666667   9.5          9.58333333
  10.63333333  11.56666667  12.35        13.25        11.96666667
  11.03333333  10.16666667  10.           8.66666667   9.15         7.25
   7.33333333   6.58333333   6.06666667   5.95         5.11666667   3.6
   3.3          3.56666667   2.48333333   1.5          1.13333333
   0.56666667]
Greg Wilson's avatar
Greg Wilson committed
676
~~~
677
{: .output}
678

679
680
As a quick check,
we can ask this array what its shape is:
681

682
~~~
683
print(numpy.mean(data, axis=0).shape)
Greg Wilson's avatar
Greg Wilson committed
684
~~~
685
{: .language-python}
686
687

~~~
Greg Wilson's avatar
Greg Wilson committed
688
689
(40,)
~~~
690
{: .output}
691

Greg Wilson's avatar
Greg Wilson committed
692
The expression `(40,)` tells us we have an N×1 vector,
693
so this is the average inflammation per day for all patients.
694
If we average across axis 1 (columns in our 2D example), we get:
695

696
~~~
697
print(numpy.mean(data, axis=1))
Greg Wilson's avatar
Greg Wilson committed
698
~~~
699
{: .language-python}
700
701

~~~
Greg Wilson's avatar
Greg Wilson committed
702
[ 5.45   5.425  6.1    5.9    5.55   6.225  5.975  6.65   6.625  6.525
703
704
705
706
707
  6.775  5.8    6.225  5.75   5.225  6.3    6.55   5.7    5.85   6.55
  5.775  5.825  6.175  6.1    5.8    6.425  6.05   6.025  6.175  6.55
  6.175  6.35   6.725  6.125  7.075  5.725  5.925  6.15   6.075  5.75
  5.975  5.725  6.3    5.9    6.75   5.925  7.225  6.15   5.95   6.275  5.7
  6.1    6.825  5.975  6.725  5.7    6.25   6.4    7.05   5.9  ]
Greg Wilson's avatar
Greg Wilson committed
708
~~~
709
{: .output}
710

711
712
which is the average inflammation per patient across all days.

713
714
715
716
## Visualizing data
The mathematician Richard Hamming once said, "The purpose of computing is insight, not numbers," and
the best way to develop insight is often to visualize data.  Visualization deserves an entire
lecture of its own, but we can explore a few features of Python's `matplotlib` library here.  While
Tyler Reddy's avatar
Tyler Reddy committed
717
there is no official plotting library, `matplotlib` is the _de facto_ standard.  First, we will
718
719
import the `pyplot` module from `matplotlib` and use two of its functions to create and display a
heat map of our data:
720

721
~~~
722
import matplotlib.pyplot
723
image = matplotlib.pyplot.imshow(data)
724
matplotlib.pyplot.show()
Greg Wilson's avatar
Greg Wilson committed
725
~~~
726
{: .language-python}
727

728
![Heatmap of the Data](../fig/01-numpy_71_0.png)
729

730
731
Blue pixels in this heat map represent low values, while yellow pixels represent high values.  As we
can see, inflammation rises and falls over a 40-day period.
732

733
> ## Some IPython Magic
734
735
736
737
>
> If you're using an IPython / Jupyter notebook,
> you'll need to execute the following command
> in order for your matplotlib images to appear
Damien Irving's avatar
Damien Irving committed
738
> in the notebook when `show()` is called:
Damien Irving's avatar
Damien Irving committed
739
>
740
> ~~~
741
> %matplotlib inline
Damien Irving's avatar
Damien Irving committed
742
> ~~~
743
> {: .language-python}
744
>
745
746
> The `%` indicates an IPython magic function -
> a function that is only valid within the notebook environment.
747
> Note that you only have to execute this function once per notebook.
748
{: .callout}
749

750
Let's take a look at the average inflammation over time:
751

752
~~~
753
ave_inflammation = numpy.mean(data, axis=0)
754
ave_plot = matplotlib.pyplot.plot(ave_inflammation)
755
matplotlib.pyplot.show()
Greg Wilson's avatar
Greg Wilson committed
756
~~~
757
{: .language-python}
758

759
![Average Inflammation Over Time](../fig/01-numpy_73_0.png)
760

761
762
763
764
Here, we have put the average per day across all patients in the variable `ave_inflammation`, then
asked `matplotlib.pyplot` to create and display a line graph of those values.  The result is a
roughly linear rise and fall, which is suspicious: we might instead expect a sharper rise and slower
fall.  Let's have a look at two other statistics:
765

766
~~~
767
max_plot = matplotlib.pyplot.plot(numpy.max(data, axis=0))
768
matplotlib.pyplot.show()
Greg Wilson's avatar
Greg Wilson committed
769
~~~
770
{: .language-python}
771

772
![Maximum Value Along The First Axis](../fig/01-numpy_75_1.png)
Greg Wilson's avatar
Greg Wilson committed
773

774
~~~
775
min_plot = matplotlib.pyplot.plot(numpy.min(data, axis=0))
776
matplotlib.pyplot.show()
Greg Wilson's avatar
Greg Wilson committed
777
~~~
778
{: .language-python}
779

780
![Minimum Value Along The First Axis](../fig/01-numpy_75_3.png)
781

782
783
784
785
The maximum value rises and falls smoothly, while the minimum seems to be a step function.  Neither
trend seems particularly likely, so either there's a mistake in our calculations or something is
wrong with our data.  This insight would have been difficult to reach by examining the numbers
themselves without visualization tools.
786

787
### Grouping plots
788
You can group similar plots in a single figure using subplots.
789
This script below uses a number of new commands. The function `matplotlib.pyplot.figure()`
790
creates a space into which we will place all of our plots. The parameter `figsize`
791
tells Python how big to make this space. Each subplot is placed into the figure using
792
793
794
its `add_subplot` [method]({{ page.root }}/reference/#method). The `add_subplot` method takes 3
parameters. The first denotes how many total rows of subplots there are, the second parameter
refers to the total number of subplot columns, and the final parameter denotes which subplot
795
796
797
your variable is referencing (left-to-right, top-to-bottom). Each subplot is stored in a
different variable (`axes1`, `axes2`, `axes3`). Once a subplot is created, the axes can
be titled using the `set_xlabel()` command (or `set_ylabel()`).
798
Here are our three plots side by side:
799

800
~~~
801
802
import numpy
import matplotlib.pyplot
803

804
data = numpy.loadtxt(fname='inflammation-01.csv', delimiter=',')
805

806
fig = matplotlib.pyplot.figure(figsize=(10.0, 3.0))
807

808
809
810
axes1 = fig.add_subplot(1, 3, 1)
axes2 = fig.add_subplot(1, 3, 2)
axes3 = fig.add_subplot(1, 3, 3)
811

812
axes1.set_ylabel('average')
813
axes1.plot(numpy.mean(data, axis=0))
814

815
axes2.set_ylabel('max')
816
axes2.plot(numpy.max(data, axis=0))
817

818
axes3.set_ylabel('min')
819
axes3.plot(numpy.min(data, axis=0))
820
821

fig.tight_layout()
822

823
matplotlib.pyplot.show()
Greg Wilson's avatar
Greg Wilson committed
824
~~~