FA_PA_LIB

Library "FA_PA_LIB"
A collection of custom tools & utility functions commonly used for coding Dr Al Brooks, Price Action System with my scripts

getBodySize()
  Gets the current candle's body size (in POINTS, divide by 10 to get pips)
  Returns: The current candle's body size in POINTS

getTopWickSize()
  Gets the current candle's top wick size (in POINTS, divide by 10 to get pips)
  Returns: The current candle's top wick size in POINTS

getTopWickPercent()
  Gets the current candle's top wick size (in POINTS, divide by 10 to get pips)
  Returns: Percent of total candle width that is occupied by the upper wick

getBottomWickSize()
  Gets the current candle's bottom wick size (in POINTS, divide by 10 to get pips)
  Returns: The current candle's bottom wick size in POINTS

getBottomWickPercent()
  Gets the current candle's bottom wick size (in POINTS, divide by 10 to get pips)
  Returns: Percent of total candle width that is occupied by the lower wick

getBarMidPoint()
  Gets the current candle's midpoint wick to wick
  Returns: The current candle's mid point

getBodyPercent()
  Gets the current candle's body size as a percentage of its entire size including its wicks
  Returns: The current candle's body size percentage (00.00)

bullFib(priceLow, priceHigh, fibRatio)
  Calculates a bullish fibonacci value
  Parameters:
    priceLow (float): The lowest price point
    priceHigh (float): The highest price point
    fibRatio (float): The fibonacci % ratio to calculate
  Returns: The fibonacci value of the given ratio between the two price points

bearFib(priceLow, priceHigh, fibRatio)
  Calculates a bearish fibonacci value
  Parameters:
    priceLow (float): The lowest price point
    priceHigh (float): The highest price point
    fibRatio (float): The fibonacci % ratio to calculate
  Returns: The fibonacci value of the given ratio between the two price points

isBr()
  Checks if the current bar is a Bear Bar
  Returns: A boolean - true if the current bar is bear candle

isBl()
  Checks if the current bar is a Bull Bar
  Returns: A boolean - true if the current bar is Bull candle

isTrendBar()
  Checks if the current bar is a Trend Bar. Candle that its body size is greater than 50% of entire candle size
  Returns: A boolean - true if the current bar is Trend candle

isBlTrendBar()
  Checks if the current bar is a Bull Trend Bar. Bullish candle that its body size is greater than 50% of entire candle size
  Returns: A boolean - true if the current bar is Bull Trend candle

isBrTrendBar()
  Checks if the current bar is a Bull Trend Bar. Bullish candle that its body size is greater than 50% of entire candle size
  Returns: A boolean - true if the current bar is Bull Trend candle

isBlRevB()
  Checks if the current bar is a Bull Reversal Bar. Bullish candle that closes on upper half of candle body
  Returns: A boolean - true if the current bar is Bull Reversal candle

isBrRevB()
  Checks if the current bar is a Bear Reversal Bar. BulBearish candle that closes on lower half of candle body
  Returns: A boolean - true if the current bar is Bear Reversal candle

isDoji(wickSize, bodySize)
  Checks if the current bar is a doji candle based on the given parameters
  Parameters:
    wickSize (float): (default=2) The maximum top wick size compared to the bottom (and vice versa)
    bodySize (float): (default=0.05) The maximum body size as a percentage compared to the entire candle size
  Returns: A boolean - true if the current bar matches the requirements of a doji candle

isHammer(fib, colorMatch)
  Checks if the current bar is a hammer candle based on the given parameters
  Parameters:
    fib (float): (default=0.382) The fib to base candle body on
    colorMatch (bool): (default=true) Does the candle need to be green? (true/false)
  Returns: A boolean - true if the current bar matches the requirements of a hammer candle

isStar(fib, colorMatch)
  Checks if the current bar is a shooting star candle based on the given parameters
  Parameters:
    fib (float): (default=0.382) The fib to base candle body on
    colorMatch (bool): (default=false) Does the candle need to be red? (true/false)
  Returns: A boolean - true if the current bar matches the requirements of a shooting star candle

isBlOB()
  Detects Bullish outside bars(OB)
  Returns: Returns true if the current bar is a bull outside bar

isBrOB()
  Detects Bearish outside bars(OB)
  Returns: Returns true if the current bar is a bear outside bar