summaryrefslogtreecommitdiffstats
path: root/website/content/SDK/alt/covid/slopes/_index.rst
blob: 31c8db5f297e7978ef1f9246127602cde180d327 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
.. role:: python(code)
    :language: python
    :class: highlight

|

To obtain charts, make sure to add :python:`chart = True` as the last parameter.

.. raw:: html

    <h3>
    > Getting data
    </h3>

{{< highlight python >}}
alt.covid.slopes(
    days_back: int = 30,
    limit: int = 50,
    threshold: int = 10000,
    ascend: bool = False,
    chart: bool = False,
) -> pandas.core.frame.DataFrame
{{< /highlight >}}

.. raw:: html

    <p>
    Load cases and find slope over period
    </p>

* **Parameters**

    days_back: int
        Number of historical days to consider
    limit: int
        Number of rows to show
    threshold: int
        Threshold for total number of cases
    ascend: bool
        Flag to sort in ascending order
    chart: bool
       Flag to display chart


* **Returns**

    pd.DataFrame
        Dataframe containing slopes

|

.. raw:: html

    <h3>
    > Getting charts
    </h3>

{{< highlight python >}}
alt.covid.slopes(
    days_back: int = 30,
    limit: int = 10,
    threshold: int = 10000,
    ascend: bool = False,
    export: str = '',
    chart: bool = False,
) -> None
{{< /highlight >}}

.. raw:: html

    <p>
    
    </p>

* **Parameters**

    days_back: int
        Number of historical days to get slope for
    limit: int
        Number to show in table
    ascend: bool
        Flag to sort in ascending order
    threshold: int
        Threshold for total cases over period
    export : str
        Format to export data
    chart: bool
       Flag to display chart