vDataFrame.cummax¶

In [ ]:

vDataFrame.cummax(column: str, 
                  by: list = [], 
                  order_by = [],
                  name: str = "")

Adds a new vcolumn to the vDataFrame by computing the cumulative maximum of the input vcolumn.

Parameters¶

Name	Type	Optional	Description
column	str	❌	Input vcolumn.
by	list	✓	vcolumns used in the partition.
order_by	dict / list	✓	List of the vcolumns to use to sort the data using asc order or dictionary of all the sorting methods. For example, to sort by "column1" ASC and "column2" DESC, write {"column1": "asc", "column2": "desc"}
name	str	✓	Name of the new vcolumn. If empty, a default name will be generated.

Returns¶

vDataFrame : self

Example¶

In [144]:

from verticapy.datasets import load_amazon
amazon = load_amazon()
display(amazon)

	Abc state Varchar(32)	📅 date Date	123 number Int
1	Acre	1998-01-01	0
2	Alagoas	1998-01-01	0
3	Amapa	1998-01-01	0
4	Amazonas	1998-01-01	0
5	Bahia	1998-01-01	0
6	Ceara	1998-01-01	0
7	Distrito Federal	1998-01-01	0
8	Espirito Santo	1998-01-01	0
9	Goias	1998-01-01	0
10	Maranhao	1998-01-01	0
11	Mato Grosso	1998-01-01	0
12	Mato Grosso	1998-01-01	0
13	Minas Gerais	1998-01-01	0
14	Para	1998-01-01	0
15	Paraiba	1998-01-01	0
16	Paraiba	1998-01-01	0
17	Pernambuco	1998-01-01	0
18	Piau	1998-01-01	0
19	Rio	1998-01-01	0
20	Rio	1998-01-01	0
21	Rio	1998-01-01	0
22	Rondonia	1998-01-01	0
23	Roraima	1998-01-01	0
24	Santa Catarina	1998-01-01	0
25	Sao Paulo	1998-01-01	0
26	Sergipe	1998-01-01	0
27	Tocantins	1998-01-01	0
28	Acre	1998-02-01	0
29	Alagoas	1998-02-01	0
30	Amapa	1998-02-01	0
31	Amazonas	1998-02-01	0
32	Bahia	1998-02-01	0
33	Ceara	1998-02-01	0
34	Distrito Federal	1998-02-01	0
35	Espirito Santo	1998-02-01	0
36	Goias	1998-02-01	0
37	Maranhao	1998-02-01	0
38	Mato Grosso	1998-02-01	0
39	Mato Grosso	1998-02-01	0
40	Minas Gerais	1998-02-01	0
41	Para	1998-02-01	0
42	Paraiba	1998-02-01	0
43	Paraiba	1998-02-01	0
44	Pernambuco	1998-02-01	0
45	Piau	1998-02-01	0
46	Rio	1998-02-01	0
47	Rio	1998-02-01	0
48	Rio	1998-02-01	0
49	Rondonia	1998-02-01	0
50	Roraima	1998-02-01	0
51	Santa Catarina	1998-02-01	0
52	Sao Paulo	1998-02-01	0
53	Sergipe	1998-02-01	0
54	Tocantins	1998-02-01	0
55	Acre	1998-03-01	0
56	Alagoas	1998-03-01	0
57	Amapa	1998-03-01	0
58	Amazonas	1998-03-01	0
59	Bahia	1998-03-01	0
60	Ceara	1998-03-01	0
61	Distrito Federal	1998-03-01	0
62	Espirito Santo	1998-03-01	0
63	Goias	1998-03-01	0
64	Maranhao	1998-03-01	0
65	Mato Grosso	1998-03-01	0
66	Mato Grosso	1998-03-01	0
67	Minas Gerais	1998-03-01	0
68	Para	1998-03-01	0
69	Paraiba	1998-03-01	0
70	Paraiba	1998-03-01	0
71	Pernambuco	1998-03-01	0
72	Piau	1998-03-01	0
73	Rio	1998-03-01	0
74	Rio	1998-03-01	0
75	Rio	1998-03-01	0
76	Rondonia	1998-03-01	0
77	Roraima	1998-03-01	0
78	Santa Catarina	1998-03-01	0
79	Sao Paulo	1998-03-01	0
80	Sergipe	1998-03-01	0
81	Tocantins	1998-03-01	0
82	Acre	1998-04-01	0
83	Alagoas	1998-04-01	0
84	Amapa	1998-04-01	0
85	Amazonas	1998-04-01	0
86	Bahia	1998-04-01	0
87	Ceara	1998-04-01	0
88	Distrito Federal	1998-04-01	0
89	Espirito Santo	1998-04-01	0
90	Goias	1998-04-01	0
91	Maranhao	1998-04-01	0
92	Mato Grosso	1998-04-01	0
93	Mato Grosso	1998-04-01	0
94	Minas Gerais	1998-04-01	0
95	Para	1998-04-01	0
96	Paraiba	1998-04-01	0
97	Paraiba	1998-04-01	0
98	Pernambuco	1998-04-01	0
99	Piau	1998-04-01	0
100	Rio	1998-04-01	0

Rows: 1-100 of 6454 | Columns: 3

In [145]:

amazon.cummax(column = "number",
              by = ["state"],
              order_by = ["date"],
              name = "cummax_number")

	Abc state Varchar(32)	📅 date Date	123 number Int	123 cummax_number Integer
1	Alagoas	1998-01-01	0	0
2	Alagoas	1998-02-01	0	0
3	Alagoas	1998-03-01	0	0
4	Alagoas	1998-04-01	0	0
5	Alagoas	1998-05-01	0	0
6	Alagoas	1998-06-01	0	0
7	Alagoas	1998-07-01	0	0
8	Alagoas	1998-08-01	1	1
9	Alagoas	1998-09-01	14	14
10	Alagoas	1998-10-01	20	20
11	Alagoas	1998-11-01	19	20
12	Alagoas	1998-12-01	32	32
13	Alagoas	1999-01-01	58	58
14	Alagoas	1999-02-01	20	58
15	Alagoas	1999-03-01	52	58
16	Alagoas	1999-04-01	4	58
17	Alagoas	1999-05-01	1	58
18	Alagoas	1999-06-01	0	58
19	Alagoas	1999-07-01	0	58
20	Alagoas	1999-08-01	3	58
21	Alagoas	1999-09-01	3	58
22	Alagoas	1999-10-01	4	58
23	Alagoas	1999-11-01	15	58
24	Alagoas	1999-12-01	12	58
25	Alagoas	2000-01-01	11	58
26	Alagoas	2000-02-01	16	58
27	Alagoas	2000-03-01	32	58
28	Alagoas	2000-04-01	20	58
29	Alagoas	2000-05-01	1	58
30	Alagoas	2000-06-01	0	58
31	Alagoas	2000-07-01	0	58
32	Alagoas	2000-08-01	4	58
33	Alagoas	2000-09-01	22	58
34	Alagoas	2000-10-01	13	58
35	Alagoas	2000-11-01	2	58
36	Alagoas	2000-12-01	2	58
37	Alagoas	2001-01-01	5	58
38	Alagoas	2001-02-01	4	58
39	Alagoas	2001-03-01	0	58
40	Alagoas	2001-04-01	0	58
41	Alagoas	2001-05-01	2	58
42	Alagoas	2001-06-01	2	58
43	Alagoas	2001-07-01	0	58
44	Alagoas	2001-08-01	1	58
45	Alagoas	2001-09-01	5	58
46	Alagoas	2001-10-01	15	58
47	Alagoas	2001-11-01	22	58
48	Alagoas	2001-12-01	30	58
49	Alagoas	2002-01-01	12	58
50	Alagoas	2002-02-01	15	58
51	Alagoas	2002-03-01	27	58
52	Alagoas	2002-04-01	6	58
53	Alagoas	2002-05-01	1	58
54	Alagoas	2002-06-01	0	58
55	Alagoas	2002-07-01	5	58
56	Alagoas	2002-08-01	3	58
57	Alagoas	2002-09-01	14	58
58	Alagoas	2002-10-01	30	58
59	Alagoas	2002-11-01	50	58
60	Alagoas	2002-12-01	95	95
61	Alagoas	2003-01-01	150	150
62	Alagoas	2003-02-01	33	150
63	Alagoas	2003-03-01	15	150
64	Alagoas	2003-04-01	20	150
65	Alagoas	2003-05-01	1	150
66	Alagoas	2003-06-01	0	150
67	Alagoas	2003-07-01	0	150
68	Alagoas	2003-08-01	2	150
69	Alagoas	2003-09-01	8	150
70	Alagoas	2003-10-01	10	150
71	Alagoas	2003-11-01	17	150
72	Alagoas	2003-12-01	43	150
73	Alagoas	2004-01-01	9	150
74	Alagoas	2004-02-01	7	150
75	Alagoas	2004-03-01	16	150
76	Alagoas	2004-04-01	6	150
77	Alagoas	2004-05-01	3	150
78	Alagoas	2004-06-01	0	150
79	Alagoas	2004-07-01	0	150
80	Alagoas	2004-08-01	2	150
81	Alagoas	2004-09-01	5	150
82	Alagoas	2004-10-01	12	150
83	Alagoas	2004-11-01	28	150
84	Alagoas	2004-12-01	71	150
85	Alagoas	2005-01-01	83	150
86	Alagoas	2005-02-01	31	150
87	Alagoas	2005-03-01	35	150
88	Alagoas	2005-04-01	1	150
89	Alagoas	2005-05-01	0	150
90	Alagoas	2005-06-01	0	150
91	Alagoas	2005-07-01	0	150
92	Alagoas	2005-08-01	2	150
93	Alagoas	2005-09-01	7	150
94	Alagoas	2005-10-01	17	150
95	Alagoas	2005-11-01	25	150
96	Alagoas	2005-12-01	16	150
97	Alagoas	2006-01-01	29	150
98	Alagoas	2006-02-01	14	150
99	Alagoas	2006-03-01	37	150
100	Alagoas	2006-04-01	2	150

Out[145]:

Rows: 1-100 of 6454 | Columns: 4

In [17]:

amazon["cummax_number"].plot(ts = "date", by = "state")

vDataFrame.cummax¶

Parameters¶

Returns¶

Example¶

See Also¶