Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[query] MT.tail should prefer n_rows to n. #13508

Merged
merged 4 commits into from Sep 6, 2023
Merged

[query] MT.tail should prefer n_rows to n. #13508

Changes from all commits
Commits
Show all changes
4 commits
Select commit Hold shift + click to select a range
c56bb95
[query] MT.tail should prefer `n_rows` to `n`.
danking Aug 28, 2023
002cae7
deprecation warning in head and tail
danking Aug 31, 2023
4d305c5
Merge remote-tracking branch 'hi/main' into fix-tail
danking Aug 31, 2023
93c1fec
fix logic bug too
danking Aug 31, 2023
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Jump to
Jump to file
Failed to load files.
Diff view
Diff view
30 changes: 23 additions & 7 deletions hail/python/hail/matrixtable.py
View file
Open in desktop
Expand Up @@ -17,6 +17,7 @@
from hail.utils.misc import wrap_to_tuple, \
get_key_by_exprs, \
get_select_exprs, check_annotate_exprs, process_joins
import warnings


class GroupedMatrixTable(ExprContainer):
Expand Down Expand Up @@ -4033,8 +4034,10 @@ def head(self, n_rows: Optional[int], n_cols: Optional[int] = None, *, n: Option
if n_rows is not None:
n_rows_name = 'n_rows'
else:
warnings.warn("MatrixTable.head: the 'n' parameter is deprecated in favor of 'n_rows'.")
n_rows = n
n_rows_name = 'n'
del n

mt = self
if n_rows is not None:
Expand All @@ -4047,8 +4050,8 @@ def head(self, n_rows: Optional[int], n_cols: Optional[int] = None, *, n: Option
mt = MatrixTable(ir.MatrixColsHead(mt._mir, n_cols))
return mt

@typecheck_method(n=nullable(int), n_cols=nullable(int))
def tail(self, n: Optional[int], n_cols: Optional[int] = None) -> 'MatrixTable':
@typecheck_method(n_rows=nullable(int), n_cols=nullable(int), n=nullable(int))
def tail(self, n_rows: Optional[int], n_cols: Optional[int] = None, *, n: Optional[int] = None) -> 'MatrixTable':
"""Subset matrix to last `n` rows.

Examples
Expand Down Expand Up @@ -4087,21 +4090,34 @@ def tail(self, n: Optional[int], n_cols: Optional[int] = None) -> 'MatrixTable':

Parameters
----------
n : :obj:`int`
n_rows : :obj:`int`
Number of rows to include (all rows included if ``None``).
n_cols : :obj:`int`, optional
Number of cols to include (all cols included if ``None``).
n : :obj:`int`
Deprecated in favor of n_rows.

Returns
-------
:class:`.MatrixTable`
Matrix including the last `n` rows and last `n_cols` cols.
"""
if n_rows is not None and n is not None:
raise ValueError('Both n and n_rows specified. Only one may be specified.')

if n_rows is not None:
n_rows_name = 'n_rows'
else:
warnings.warn("MatrixTable.tail: the 'n' parameter is deprecated in favor of 'n_rows'.")
n_rows = n
n_rows_name = 'n'
del n

mt = self
if n is not None:
if n < 0:
raise ValueError(f"MatrixTable.tail: expect 'n' to be non-negative or None, found '{n}'")
mt = MatrixTable(ir.MatrixRowsTail(mt._mir, n))
if n_rows is not None:
if n_rows < 0:
raise ValueError(f"MatrixTable.tail: expect '{n_rows_name}' to be non-negative or None, found '{n_rows}'")
mt = MatrixTable(ir.MatrixRowsTail(mt._mir, n_rows))
if n_cols is not None:
if n_cols < 0:
raise ValueError(f"MatrixTable.tail: expect 'n_cols' to be non-negative or None, found '{n_cols}'")
Expand Down