kquant API document (0.3.6)

below_value

시계열 값이 기준 설정값 이하이면 True, 초과면 False를 반환하는 함수

below_value(
    df: 'pd.DataFrame',
    column: 'str',
    value: 'float',
    out_column: 'str'='BELOW',
    inplace: 'bool'=False,
) -> pd.DataFrame
  • df (pd.DataFrame): 가격 데이터를 포함한 pandas 데이터프레임
  • column (str): 입력 컬럼 이름 문자열.
  • value (float): 기준 설정값.
  • 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],
})
kq.above_value(df, "A", 1)
A ABOVE
0 0 False
1 1 True
2 2 True
3 3 True
4 2 True
5 1 True
6 0 False