Skip to content

Commit 2f52669

Browse files
xenatischxenatisch
committed
updates examples
1 parent 1cd98ed commit 2f52669

File tree

5 files changed

+26
-26
lines changed

5 files changed

+26
-26
lines changed

‎docs/source/pages/examples/general_use.rst‎

Lines changed: 8 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -40,8 +40,8 @@ In the case of this example, the metrics are as follows:
4040

4141
- ``newCasesByPublishDate``: New cases (by publish date)
4242
- ``cumCasesByPublishDate``: Cumulative cases (by publish date)
43-
- ``newDeathsByDeathDate``: New deaths (by death date)
44-
- ``cumDeathsByDeathDate``: Cumulative deaths (by death date)
43+
- ``newDeaths28DaysByDeathDate``: New deaths (by death date)
44+
- ``cumDeaths28DaysByDeathDate``: Cumulative deaths (by death date)
4545

4646
In its simplest form, we construct the structure as follows:
4747

@@ -53,8 +53,8 @@ In its simplest form, we construct the structure as follows:
5353
"areaCode": "areaCode",
5454
"newCasesByPublishDate": "newCasesByPublishDate",
5555
"cumCasesByPublishDate": "cumCasesByPublishDate",
56-
"newDeathsByDeathDate": "newDeathsByDeathDate",
57-
"cumDeathsByDeathDate": "cumDeathsByDeathDate"
56+
"newDeaths28DaysByDeathDate": "newDeaths28DaysByDeathDate",
57+
"cumDeaths28DaysByDeathDate": "cumDeaths28DaysByDeathDate"
5858
}
5959
6060
@@ -92,17 +92,17 @@ or ``.get_dataframe()`` methods:
9292
'areaCode': 'E92000001',
9393
'newCasesByPublishDate': 547,
9494
'cumCasesByPublishDate': 259022,
95-
'newDeathsByDeathDate': None,
96-
'cumDeathsByDeathDate': None
95+
'newDeaths28DaysByDeathDate': None,
96+
'cumDeaths28DaysByDeathDate': None
9797
},
9898
{
9999
'date': '2020-07-27',
100100
'areaName': 'England',
101101
'areaCode': 'E92000001',
102102
'newCasesByPublishDate': 616,
103103
'cumCasesByPublishDate': 258475,
104-
'newDeathsByDeathDate': 20,
105-
'cumDeathsByDeathDate': 41282
104+
'newDeaths28DaysByDeathDate': 20,
105+
'cumDeaths28DaysByDeathDate': 41282
106106
},
107107
...
108108
],

‎docs/source/pages/examples/latest_data.rst‎

Lines changed: 10 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,8 @@ the ``structure``. A list of metrics is available on the `Developers Guide`_ web
3737
"areaCode": "areaCode",
3838
"newCasesByPublishDate": "newCasesByPublishDate",
3939
"cumCasesByPublishDate": "cumCasesByPublishDate",
40-
"newDeathsByDeathDate": "newDeathsByDeathDate",
41-
"cumDeathsByDeathDate": "cumDeathsByDeathDate"
40+
"newDeaths28DaysByDeathDate": "newDeaths28DaysByDeathDate",
41+
"cumDeaths28DaysByDeathDate": "cumDeaths28DaysByDeathDate"
4242
}
4343
4444
api = Cov19API(
@@ -61,35 +61,35 @@ the ``structure``. A list of metrics is available on the `Developers Guide`_ web
6161
"areaCode": "E92000001",
6262
"newCasesByPublishDate": 547,
6363
"cumCasesByPublishDate": 259022,
64-
"newDeathsByDeathDate": None,
65-
"cumDeathsByDeathDate": None
64+
"newDeaths28DaysByDeathDate": None,
65+
"cumDeaths28DaysByDeathDate": None
6666
},
6767
{
6868
"date": "2020-07-28",
6969
"areaName": "Northern Ireland",
7070
"areaCode": "N92000002",
7171
"newCasesByPublishDate": 9,
7272
"cumCasesByPublishDate": 5921,
73-
"newDeathsByDeathDate": None,
74-
"cumDeathsByDeathDate": None
73+
"newDeaths28DaysByDeathDate": None,
74+
"cumDeaths28DaysByDeathDate": None
7575
},
7676
{
7777
"date": "2020-07-28",
7878
"areaName": "Scotland",
7979
"areaCode": "S92000003",
8080
"newCasesByPublishDate": 4,
8181
"cumCasesByPublishDate": 18558,
82-
"newDeathsByDeathDate": None,
83-
"cumDeathsByDeathDate": None
82+
"newDeaths28DaysByDeathDate": None,
83+
"cumDeaths28DaysByDeathDate": None
8484
},
8585
{
8686
"date": "2020-07-28",
8787
"areaName": "Wales",
8888
"areaCode": "W92000004",
8989
"newCasesByPublishDate": 21,
9090
"cumCasesByPublishDate": 17191,
91-
"newDeathsByDeathDate": None,
92-
"cumDeathsByDeathDate": None
91+
"newDeaths28DaysByDeathDate": None,
92+
"cumDeaths28DaysByDeathDate": None
9393
}
9494
],
9595
"lastUpdate": "2020-07-28T15:34:31.000000Z",

‎docs/source/pages/examples/pandas.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -23,8 +23,8 @@ Pandas ``DataFrame`` object.
2323
"areaCode": "areaCode",
2424
"newCasesByPublishDate": "newCasesByPublishDate",
2525
"cumCasesByPublishDate": "cumCasesByPublishDate",
26-
"newDeathsByDeathDate": "newDeathsByDeathDate",
27-
"cumDeathsByDeathDate": "cumDeathsByDeathDate"
26+
"newDeaths28DaysByDeathDate": "newDeaths28DaysByDeathDate",
27+
"cumDeaths28DaysByDeathDate": "cumDeaths28DaysByDeathDate"
2828
}
2929
3030
api = Cov19API(
@@ -38,7 +38,7 @@ Pandas ``DataFrame`` object.
3838
3939
::
4040

41-
date areaName areaCode newCasesByPublishDate cumCasesByPublishDate newDeathsByDeathDate cumDeathsByDeathDate
41+
date areaName areaCode newCasesByPublishDate cumCasesByPublishDate newDeaths28DaysByDeathDate cumDeaths28DaysByDeathDate
4242
0 2020-08-08 England E92000001 679 267324.0 None None
4343
1 2020-08-08 Northern Ireland N92000002 0 NaN None None
4444
2 2020-08-08 Scotland S92000003 60 18950.0 None None

‎docs/source/pages/examples/saving.rst‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -29,8 +29,8 @@ methods.
2929
"areaCode": "areaCode",
3030
"newCasesByPublishDate": "newCasesByPublishDate",
3131
"cumCasesByPublishDate": "cumCasesByPublishDate",
32-
"newDeathsByDeathDate": "newDeathsByDeathDate",
33-
"cumDeathsByDeathDate": "cumDeathsByDeathDate"
32+
"newDeaths28DaysByDeathDate": "newDeaths28DaysByDeathDate",
33+
"cumDeaths28DaysByDeathDate": "cumDeaths28DaysByDeathDate"
3434
}
3535
3636
api = Cov19API(
@@ -47,7 +47,7 @@ contents of the file would be as follows:
4747

4848
::
4949

50-
date,areaName,areaCode,newCasesByPublishDate,cumCasesByPublishDate,newDeathsByDeathDate,cumDeathsByDeathDate
50+
date,areaName,areaCode,newCasesByPublishDate,cumCasesByPublishDate,newDeaths28DaysByDeathDate,cumDeaths28DaysByDeathDate
5151
2020-07-28,England,E92000001,547,259022,,
5252
2020-07-28,Northern Ireland,N92000002,9,5921,,
5353
2020-07-28,Scotland,S92000003,4,18558,,

‎docs/source/pages/examples/timestamps.rst‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -52,8 +52,8 @@ Latest API timestamp
5252
"areaCode": "areaCode",
5353
"newCasesByPublishDate": "newCasesByPublishDate",
5454
"cumCasesByPublishDate": "cumCasesByPublishDate",
55-
"newDeathsByDeathDate": "newDeathsByDeathDate",
56-
"cumDeathsByDeathDate": "cumDeathsByDeathDate"
55+
"newDeaths28DaysByDeathDate": "newDeaths28DaysByDeathDate",
56+
"cumDeaths28DaysByDeathDate": "cumDeaths28DaysByDeathDate"
5757
}
5858
5959
england_only = [

0 commit comments

Comments
 (0)