pyjanitor-devs/pyjanitor

Add the ability to test whether data is in range in a pandas data frame

Open

#708 opened on Jul 29, 2020

View on GitHub
 (3 comments) (0 reactions) (0 assignees)Python (164 forks)batch import
available for hackingenhancementgood first issue

Repository metrics

Stars
 (1,217 stars)
PR merge metrics
 (Avg merge 2d 12h) (4 merged PRs in 30d)

Description

Brief Description

Following up on #703, this issue seeks to introduce the ability to test whether each column in a data frame is within a user-defined range of values.

I would like to propose..

Example API

def flag_values_not_in_range(
        df: pd.DataFrame,
        bound: list,
        inclusive: bool = True
) -> pd.DataFrame:
    """
    :param df: data frame to test if values in columns are within a range
    :param bound: user-defined lower and upper bound of values to test in data frame columns
    :param inclusive: include boundaries in filtering.
        Defaults to True
    :return: True if value in column does not fall within range.
        False if value in column falls within range.
    """

Contributor guide

Research direction
Implement the function flag values not in range as described; use boolean indexing to check each column against bounds.
Tech stack
pythonpandas
Domain
data
Issue type
Feature
DifficultyEstimated implementation difficulty for a new contributor, from 1 for very small changes to 5 for expert-level work.
2
Estimated timeA rough time range for an experienced contributor to investigate, implement, test, and prepare a pull request.
1-3 hours
Activity statusHow available the issue appears right now: fresh, active, stale, blocked, or waiting on maintainer input.
Active
ClarityHow clearly the issue explains the expected change, acceptance criteria, and next step.
Clear
Prerequisites
Pythonpandas
Newbie friendlinessA 1-100 score estimating how approachable this issue is for first-time contributors.
75