kquant API document (0.3.6)

below

A 시계열 값이 B 시계열 값 이하이면 True, 초과면 False를 반환하는 함수

below(
    df: 'pd.DataFrame',
    column_a: 'str',
    column_b: 'str',
    out_column: 'str'='BELOW',
    inplace: 'bool'=False,
) -> pd.DataFrame

df (pd.DataFrame): pandas 데이터프레임
column_a (str): 입력 컬럼 A의 이름 문자열.
column_a (str): 입력 컬럼 B의 이름 문자열.
out_column (str): 출력 컬럼의 이름 문자열. 디폴트 “BELOW”.
inplace (bool): inplace=True 이면 계산 결과를 입력 데이터프레임에 추가. inplace=True 이면 계산 결과를 복사된 데이터프레임에 추가. 디폴트는 False.
반환값 (pd.DataFrame): 계산된 데이터 컬럼이 포함된 pandas 데이터프레임

import pandas as pd

import kquant as kq

df = pd.DataFrame({
    "A": [0,1,2,3,2,1,0],
    "B": [1,1,1,1,1,1,1],
})

kq.below(df, "A", "B")