openalgo-script 0.1.0-alpha.1 → 0.4.0

package/src/core/check/library-prose.generated.ts

@@ -0,0 +1,367 @@
+/**
+ * What the specification says each library name is for, read from its own
+ * tables.
+ *
+ * Generated by scripts/generate-library-prose.mjs from the documents it names.
+ * Do not edit: the next build overwrites it, and a sentence edited here would
+ * be a second answer to a question spec/stdlib.md already answers.
+ */
+export interface LibraryProse {
+  /** One line on what the call is for, from the last column of its own row. */
+  readonly summary: string;
+  /** The first bar it can produce a value for, where its table states one. */
+  readonly warmup?: string;
+}
+
+export const LIBRARY_PROSE: Readonly<Record<string, LibraryProse>> = {
+  "abs": {"summary":"Magnitude without sign"},
+  "ad": {"summary":"Running total of volume weighted by where the close sat in the bar","warmup":"bar 0"},
+  "adOsc": {"summary":"The difference of two means of `ad`, to date its turns","warmup":"bar `max(fast, slow) - 1`"},
+  "adx": {"summary":"`[adx, plusDI, minusDI]`; trend strength and which side owns it","warmup":"element 1 and 2 at bar `diLen`, element 0 at bar `diLen + adxLen - 1`"},
+  "alert": {"summary":"Raise a named alert on this bar"},
+  "alma": {"summary":"Gaussian weighted mean whose peak `offset` slides between lag and smoothness","warmup":"bar `len - 1`"},
+  "alpha": {"summary":"Read a colour's alpha, 0 to 1"},
+  "aroon": {"summary":"`[up, down]`; how recently the window's high and low were set, as a percentage","warmup":"both elements at bar `len`"},
+  "arrayEqual": {"summary":"Whether two arrays hold equal elements in the same order, as against `==`, which is identity"},
+  "atr": {"summary":"`rma` of `trueRange`, the working measure of how far this instrument moves","warmup":"bar `len - 1`"},
+  "avg": {"summary":"Statistics over the whole array"},
+  "avgSkip": {"summary":"Mean over the window, ignoring absent bars","warmup":"bar `len - 1`"},
+  "awesomeOsc": {"summary":"Difference of two simple means of `hl2`, drawn as a histogram","warmup":"bar `max(fast, slow) - 1`"},
+  "background": {"summary":"Shade the whole height of this bar's column behind everything else"},
+  "bar.count": {"summary":"`bar.index + 1`, bars seen so far","warmup":"bar 0"},
+  "bar.index": {"summary":"Position of this bar in the dataset, oldest is 0","warmup":"bar 0"},
+  "bar.isConfirmed": {"summary":"This bar's interval has elapsed and it will not change again","warmup":"bar 0"},
+  "bar.isFirst": {"summary":"This is the oldest bar supplied","warmup":"bar 0"},
+  "bar.isLast": {"summary":"This is the newest bar supplied","warmup":"bar 0"},
+  "bar.isNew": {"summary":"The last update appended a bar rather than replacing one","warmup":"bar 0"},
+  "bar.isRealtime": {"summary":"A live feed is driving updates, rather than a one-off history load","warmup":"bar 0"},
+  "bar.updates": {"summary":"How many times this bar has been executed","warmup":"bar 0"},
+  "barColor": {"summary":"Recolour the instrument's own candles on this bar"},
+  "barsSince": {"summary":"Bars since the condition last held, 0 on the bar itself","warmup":"first bar `cond` is true"},
+  "bbPercent": {"summary":"Where price sits between the bands, 0 at the lower and 1 at the upper","warmup":"bar `len - 1`"},
+  "bbWidth": {"summary":"Band width over the basis, a squeeze reads as a low","warmup":"bar `len - 1`"},
+  "bollinger": {"summary":"`[basis, upper, lower]`; a mean with deviation bands","warmup":"all elements at bar `len - 1`"},
+  "book.dailyLoss": {"summary":"Square off and stop entering for the day when the day's loss reaches `amount`"},
+  "book.dayProfit": {"summary":"The same measured from this session's open, which is what `book.dailyLoss` tests","warmup":"bar 0"},
+  "book.direction": {"summary":"`\"long\"`, `\"short\"` or `\"both\"`, which sides an entry may take"},
+  "book.enter": {"summary":"Enter the whole book as a unit"},
+  "book.entryWindow": {"summary":"New entries only inside this window, written as section 12.5 writes one"},
+  "book.exit": {"summary":"Exit the whole book as a unit"},
+  "book.exitAt": {"summary":"Square off every leg at this `\"HHMM\"` in the chart's timezone"},
+  "book.isOpen": {"summary":"Whether any leg holds a position","warmup":"bar 0"},
+  "book.lockProfit": {"summary":"Arm a floor at a profit, then advance it as profit grows"},
+  "book.profit": {"summary":"The book's profit in money, open and realised since it was last flat","warmup":"bar 0"},
+  "book.squareOffAtExpiry": {"summary":"Square off a leg this many minutes before its contract expires"},
+  "book.stop": {"summary":"Square off every leg when the book's profit falls to `-amount`"},
+  "book.target": {"summary":"Square off every leg when the book's profit reaches `amount`"},
+  "book.trailStopsToEntry": {"summary":"Move every leg's stop to its own entry once the book is `at` in profit"},
+  "buy": {"summary":"Enter or add to a long position in one leg"},
+  "cancel": {"summary":"Cancel a working order that has not filled"},
+  "cancelAll": {"summary":"Cancel every working order this strategy placed"},
+  "cci": {"summary":"How far the typical price sits from its mean in mean-deviation units","warmup":"bar `len - 1`"},
+  "ceil": {"summary":"Toward positive infinity"},
+  "cell": {"summary":"Write one cell on this bar"},
+  "change": {"summary":"`src - src[1]`","warmup":"bar 1"},
+  "chart.currency": {"summary":"Currency label for money in a report","warmup":"n/a"},
+  "chart.exchange": {"summary":"The exchange the instrument trades on","warmup":"n/a"},
+  "chart.expiry": {"summary":"Expiry instant of a derivative instrument","warmup":"n/a"},
+  "chart.hasOpenInterest": {"summary":"The host supplies open interest for this instrument","warmup":"n/a"},
+  "chart.hasVolume": {"summary":"The host supplies volume for this instrument","warmup":"n/a"},
+  "chart.instrumentType": {"summary":"`\"equity\"`, `\"future\"`, `\"option\"`, `\"index\"`, `\"currency\"`, `\"commodity\"` or `\"other\"`","warmup":"n/a"},
+  "chart.interval": {"summary":"The chart's interval in canonical form, section 15.2","warmup":"n/a"},
+  "chart.intervalMinutes": {"summary":"The interval in minutes, `none` for a non-time interval","warmup":"n/a"},
+  "chart.isIntraday": {"summary":"The interval is shorter than one day","warmup":"n/a"},
+  "chart.isReplay": {"summary":"The bars are being replayed rather than loaded whole","warmup":"n/a"},
+  "chart.lotSize": {"summary":"Units in one lot, `none` when the host has not said","warmup":"n/a"},
+  "chart.now": {"summary":"The chart's wall clock, UTC milliseconds","warmup":"n/a"},
+  "chart.optionType": {"summary":"`\"call\"`, `\"put\"` or `\"\"`","warmup":"n/a"},
+  "chart.pointValue": {"summary":"Money per one point of price per unit, `none` when unknown","warmup":"n/a"},
+  "chart.strike": {"summary":"Strike price of an option instrument","warmup":"n/a"},
+  "chart.symbol": {"summary":"The instrument's symbol, or `\"\"` when the host names none","warmup":"n/a"},
+  "chart.tickSize": {"summary":"The instrument's smallest price increment, `none` when the host has not said","warmup":"n/a"},
+  "chart.timezone": {"summary":"The chart's IANA zone, the calendar its axis is labelled in","warmup":"n/a"},
+  "chop": {"summary":"0 to 100 reading of whether the window trended or chopped","warmup":"bar `len`"},
+  "clamp": {"summary":"`x` held inside a range"},
+  "clear": {"summary":"Empty every cell, so a table can be rebuilt from scratch"},
+  "close": {"summary":"The bar's closing price, the last price on a bar still forming","warmup":"bar 0"},
+  "cmf": {"summary":"Accumulation over the window as a fraction of its volume","warmup":"bar `len - 1`"},
+  "cmo": {"summary":"Up sum minus down sum over their total, -100 to 100","warmup":"bar `len`"},
+  "coppock": {"summary":"Long horizon momentum turn","warmup":"bar `max(roc1, roc2) + wmaLen - 1`"},
+  "copy": {"summary":"An independent copy"},
+  "correlation": {"summary":"Linear correlation of two series over the window, -1 to 1","warmup":"bar `len - 1`"},
+  "count": {"summary":"How many of the last `len` bars the condition held on","warmup":"bar `len - 1`"},
+  "countPresent": {"summary":"How many bars of the window had a value","warmup":"bar `len - 1`"},
+  "covariance": {"summary":"Covariance over the window, population form","warmup":"bar `len - 1`"},
+  "cross": {"summary":"Either direction","warmup":"bar 1"},
+  "crossDown": {"summary":"`a` was at or above `b` and is now below","warmup":"bar 1"},
+  "crossUp": {"summary":"`a` was at or below `b` and is now above","warmup":"bar 1"},
+  "cum": {"summary":"Running total from the first bar","warmup":"bar 0"},
+  "cvd": {"summary":"Cumulative signed volume, once the host supplies intrabar data","warmup":"bar 0"},
+  "date.add": {"summary":"Calendar arithmetic that respects month lengths and daylight saving"},
+  "date.day": {"summary":"Day of the month, 1 to 31"},
+  "date.dayOfWeek": {"summary":"1 for Monday through 7 for Sunday"},
+  "date.dayOfYear": {"summary":"1 to 366"},
+  "date.format": {"summary":"Render a timestamp, section 12.3"},
+  "date.from": {"summary":"Build a timestamp from calendar fields"},
+  "date.hour": {"summary":"0 to 23"},
+  "date.isSameDay": {"summary":"Whether two timestamps fall on one calendar day"},
+  "date.minute": {"summary":"0 to 59"},
+  "date.month": {"summary":"Month, 1 to 12"},
+  "date.second": {"summary":"0 to 59"},
+  "date.startOfDay": {"summary":"Midnight at the start of `t`'s day"},
+  "date.startOfMonth": {"summary":"Midnight on the first of `t`'s month"},
+  "date.startOfWeek": {"summary":"Midnight at the start of `t`'s Monday"},
+  "date.weekOfYear": {"summary":"Week number, weeks starting Monday"},
+  "date.year": {"summary":"Calendar year"},
+  "dema": {"summary":"Double exponential mean, an `ema` with its own lag subtracted once","warmup":"bar `2 * len - 2`"},
+  "donchian": {"summary":"`[upper, basis, lower]`; the window's outright high, midpoint and low","warmup":"all elements at bar `len - 1`"},
+  "dpo": {"summary":"Price with its displaced mean removed, to expose a cycle","warmup":"bar `len + floor(len / 2)`"},
+  "draw.box": {"summary":"A zone: supply, demand, an opening range"},
+  "draw.count": {"summary":"How many objects this script currently holds"},
+  "draw.delete": {"summary":"box"},
+  "draw.deleteAll": {"summary":"Remove every object this script created"},
+  "draw.label": {"summary":"A plate of text at a point"},
+  "draw.line": {"summary":"A trendline between two points"},
+  "draw.polyline": {"summary":"A path or a closed shape through many points"},
+  "draw.setAt": {"summary":"Move a label"},
+  "draw.setBounds": {"summary":"nothing"},
+  "draw.setColor": {"summary":"box"},
+  "draw.setExtend": {"summary":"Continue a line to the pane edge"},
+  "draw.setFillColor": {"summary":"nothing"},
+  "draw.setFrom": {"summary":"nothing"},
+  "draw.setPoints": {"summary":"Replace a polyline's path"},
+  "draw.setStyle": {"summary":"`\"solid\"`, `\"dashed\"` or `\"dotted\"`"},
+  "draw.setText": {"summary":"nothing"},
+  "draw.setTextColor": {"summary":"nothing"},
+  "draw.setTo": {"summary":"nothing"},
+  "draw.setTooltip": {"summary":"nothing"},
+  "draw.setWidth": {"summary":"polyline, width)`"},
+  "element": {"summary":"Read element `i`"},
+  "ema": {"summary":"Exponential mean, weight `2 / (len + 1)`, seeded on bar `len - 1` with the simple average of those `len` values","warmup":"bar `len - 1`"},
+  "eom": {"summary":"How far price moved per unit of volume","warmup":"bar `len`"},
+  "exit": {"summary":"Set the leg's stop or target from a call site"},
+  "exp": {"summary":"`e` to the power `x`"},
+  "fade": {"summary":"The same colour at `percent` transparency, where 100 is invisible"},
+  "falling": {"summary":"True when each of the last `len` changes was negative","warmup":"bar `len`"},
+  "fill": {"summary":"Shade the region between two declared plots"},
+  "fisher": {"summary":"`[fisher, trigger]`; range position reshaped so extremes stand out","warmup":"bar `len`"},
+  "floor": {"summary":"Toward negative infinity"},
+  "forceIndex": {"summary":"Change times volume, smoothed","warmup":"bar `len`"},
+  "gradient": {"summary":"Position a value between two colours"},
+  "high": {"summary":"The bar's highest traded price","warmup":"bar 0"},
+  "highest": {"summary":"Largest value in the last `len` bars","warmup":"bar `len - 1`"},
+  "highestBars": {"summary":"How many bars back the window's high was set, 0 for this bar","warmup":"bar `len - 1`"},
+  "history": {"summary":"`src` as it stood `n` bars ago, the explicit form of `src[n]`","warmup":"bar `n`"},
+  "hl2": {"summary":"`(high + low) / 2`, the bar's midpoint","warmup":"bar 0"},
+  "hlc3": {"summary":"`(high + low + close) / 3`, the typical price","warmup":"bar 0"},
+  "hlcc4": {"summary":"`(high + low + close + close) / 4`, close-weighted average","warmup":"bar 0"},
+  "hma": {"summary":"Weighted mean tuned to lag less than `wma` at the same length","warmup":"bar `len + round(sqrt(len)) - 2`"},
+  "hsl": {"summary":"Hue, saturation, lightness construction"},
+  "hv": {"summary":"Annualised standard deviation of log returns","warmup":"bar `len`"},
+  "ichimoku": {"summary":"`[conversion, base, spanA, spanB, lagging]`; a five line trend frame, displaced with `plot(..., offset = ...)`","warmup":"element by element at bar `convLen - 1`, `baseLen - 1`, `baseLen - 1`, `spanLen - 1`, `baseLen - 1`"},
+  "indexOf": {"summary":"First index of `v`, or `-1`"},
+  "input": {"summary":"A length, a multiplier, a threshold"},
+  "insert": {"summary":"Insert before index `i`"},
+  "isNone": {"summary":"True when the value is absent"},
+  "kama": {"summary":"Mean whose smoothing follows how directional the move is","warmup":"bar `len`"},
+  "keltner": {"summary":"`[basis, upper, lower]`; the same picture built from `atr` instead of deviation","warmup":"all elements at bar `max(len, atrLen) - 1`"},
+  "klinger": {"summary":"`[klinger, signal]`; volume force against the bar's trend","warmup":"bar `slow + signal - 2`"},
+  "leg.avgPrice": {"summary":"Average price of the leg's open position","warmup":"absent while the leg is flat"},
+  "leg.enter": {"summary":"Enter one leg on its own signal"},
+  "leg.entryTime": {"summary":"When the leg's current position was opened","warmup":"absent while the leg is flat"},
+  "leg.exchange": {"summary":"The exchange the orders were sent to","warmup":"bar 0"},
+  "leg.exit": {"summary":"Exit one leg on its own signal"},
+  "leg.expiry": {"summary":"The resolved contract's expiry, absent for a contract with none","warmup":"bar 0"},
+  "leg.fixed": {"summary":"Declare a leg on a contract named outright"},
+  "leg.isOpen": {"summary":"Whether the leg holds a position","warmup":"bar 0"},
+  "leg.product": {"summary":"The product actually sent, section 17.7","warmup":"bar 0"},
+  "leg.profit": {"summary":"The leg's open profit in money, marked to this bar's close","warmup":"bar 0, `0` when flat"},
+  "leg.relative": {"summary":"Declare a leg on a contract named relatively"},
+  "leg.size": {"summary":"Signed units this strategy holds in the leg","warmup":"bar 0, `0` when flat"},
+  "leg.stop": {"summary":"Close the leg when its price reaches `price` against the position"},
+  "leg.stopPrice": {"summary":"The stop actually in force, from whichever call set it","warmup":"absent when no stop is in force"},
+  "leg.strike": {"summary":"The resolved contract's strike, absent for a contract with none","warmup":"bar 0"},
+  "leg.symbol": {"summary":"The resolved contract, which is what the orders carried","warmup":"bar 0"},
+  "leg.target": {"summary":"Close the leg when its price reaches `price` in favour of the position"},
+  "leg.targetPrice": {"summary":"The target actually in force","warmup":"absent when no target is in force"},
+  "leg.trail": {"summary":"Follow the best price the leg has seen, `distance` behind it"},
+  "level": {"summary":"A fixed reference line in the study's pane"},
+  "linreg": {"summary":"Value of the least squares line through the last `len` points, `offset` bars back along it","warmup":"bar `len - 1`"},
+  "log": {"summary":"Natural logarithm, `none` at or below zero"},
+  "log10": {"summary":"Base ten logarithm, same absence rule"},
+  "low": {"summary":"The bar's lowest traded price","warmup":"bar 0"},
+  "lowest": {"summary":"Smallest value in the last `len` bars","warmup":"bar `len - 1`"},
+  "lowestBars": {"summary":"How many bars back the window's low was set","warmup":"bar `len - 1`"},
+  "ma": {"summary":"One call whose shape a `select` input can switch: `\"sma\"`, `\"ema\"`, `\"wma\"`, `\"rma\"`, `\"hma\"`, `\"vwma\"`","warmup":"the named type's"},
+  "macd": {"summary":"`[macd, signal, histogram]`; the gap between a fast and a slow mean","warmup":"element 0 at bar `max(fast, slow) - 1`, elements 1 and 2 at bar `max(fast, slow) + signal - 2`"},
+  "massIndex": {"summary":"Range expansion as a reversal warning","warmup":"bar `len + 17`"},
+  "math.acos": {"summary":"Inverse cosine, same range rule"},
+  "math.asin": {"summary":"Inverse sine, `none` outside -1 to 1"},
+  "math.atan": {"summary":"Inverse tangent"},
+  "math.atan2": {"summary":"Angle of a vector, correct in all four quadrants"},
+  "math.cos": {"summary":"Cosine"},
+  "math.cosh": {"summary":"Hyperbolic cosine"},
+  "math.e": {"summary":"The base of the natural logarithm"},
+  "math.hypot": {"summary":"`sqrt(x * x + y * y)` without intermediate overflow"},
+  "math.log2": {"summary":"Base two logarithm"},
+  "math.pi": {"summary":"The circle constant"},
+  "math.sin": {"summary":"Sine of an angle in radians"},
+  "math.sinh": {"summary":"Hyperbolic sine"},
+  "math.tan": {"summary":"Tangent"},
+  "math.tanh": {"summary":"Hyperbolic tangent"},
+  "math.toDegrees": {"summary":"Radians to degrees"},
+  "math.toRadians": {"summary":"Degrees to radians"},
+  "max": {"summary":"The larger of two"},
+  "median": {"summary":"Middle value of the window","warmup":"bar `len - 1`"},
+  "mfi": {"summary":"`rsi` computed on money flow rather than price","warmup":"bar `len`"},
+  "min": {"summary":"The smaller of two"},
+  "mix": {"summary":"Blend of two colours, `weight` 0 gives `a` and 1 gives `b`"},
+  "mod": {"summary":"`a - b * floor(a / b)`, the floored remainder, whose sign follows `b`; `none` when `b` is zero"},
+  "mom": {"summary":"`src - src[len]`, change over a fixed distance","warmup":"bar `len`"},
+  "natr": {"summary":"`atr` as a percentage of close, so two instruments compare","warmup":"bar `len - 1`"},
+  "notify": {"summary":"Send an alert somewhere the host has configured"},
+  "nvi": {"summary":"Cumulative change on bars where volume fell","warmup":"bar 1"},
+  "obv": {"summary":"Running total of volume signed by the close's direction","warmup":"bar 0, seeded 0"},
+  "ohlc4": {"summary":"`(open + high + low + close) / 4`, the average price","warmup":"bar 0"},
+  "oi": {"summary":"Contracts outstanding at the end of the bar, absent where the host supplies none","warmup":"bar 0"},
+  "open": {"summary":"The bar's opening price","warmup":"bar 0"},
+  "orElse": {"summary":"`x` when present, `fallback` when absent"},
+  "order.avgFill": {"summary":"Average fill price for that tag, absent before the first fill"},
+  "order.bracket": {"summary":"Set the leg's stop and target as distances from the entry"},
+  "order.filled": {"summary":"Cumulative filled quantity for that tag, `0` before the first fill"},
+  "order.id": {"summary":"The destination's own reference for that tag, `\"\"` before the destination has answered"},
+  "order.modify": {"summary":"Change a working order's price or quantity in place"},
+  "order.oco": {"summary":"Cancel one order when the other fills"},
+  "order.pending": {"summary":"How many orders are live and unfilled"},
+  "order.place": {"summary":"The general form, for a script that computes its side"},
+  "order.qtyForCash": {"summary":"Size from an amount of money"},
+  "order.qtyForEquityPercent": {"summary":"Size from a percentage of current equity"},
+  "order.qtyForRisk": {"summary":"Size so that being stopped out costs `risk`"},
+  "order.rejection": {"summary":"The destination's own rejection text, `\"\"` when there is none"},
+  "order.reverse": {"summary":"Close a leg's position and open the same size the other way, as the two orders of section 17.1"},
+  "order.roundToLot": {"summary":"Round to a whole multiple of that leg's lot size"},
+  "order.status": {"summary":"The ledger's folded status for that tag, section 17.7"},
+  "order.working": {"summary":"Whether an order with that tag is live and unfilled"},
+  "percentRank": {"summary":"What percentage of the window this bar's value exceeds","warmup":"bar `len - 1`"},
+  "percentile": {"summary":"The value at percentile `p` of the window, linearly interpolated","warmup":"bar `len - 1`"},
+  "pivotHigh": {"summary":"The value of a local high, reported `right` bars after it formed","warmup":"bar `left + right`"},
+  "pivotLow": {"summary":"The value of a local low, on the same terms","warmup":"bar `left + right`"},
+  "plot": {"summary":"Draw a column of numbers"},
+  "plotCandles": {"summary":"Draw bar-shaped output: a smoothed or higher timeframe candle"},
+  "pop": {"summary":"Remove and return the last element"},
+  "pos.avgPrice": {"summary":"Average price of the open position","warmup":"absent while flat"},
+  "pos.barsHeld": {"summary":"Bars since it was opened, 0 on the entry bar","warmup":"absent while flat"},
+  "pos.entries": {"summary":"How many entries make up the current position, for a pyramiding rule","warmup":"bar 0"},
+  "pos.entryTime": {"summary":"When the current position was opened","warmup":"absent while flat"},
+  "pos.equity": {"summary":"Starting capital plus realised and unrealised profit","warmup":"bar 0"},
+  "pos.isFlat": {"summary":"`pos.size == 0`","warmup":"bar 0"},
+  "pos.isLong": {"summary":"`pos.size > 0`","warmup":"bar 0"},
+  "pos.isShared": {"summary":"The account holds a position in a contract this strategy also holds","warmup":"bar 0"},
+  "pos.isShort": {"summary":"`pos.size < 0`","warmup":"bar 0"},
+  "pos.maxDrawdown": {"summary":"Largest peak to trough fall in equity so far","warmup":"bar 0"},
+  "pos.maxLoss": {"summary":"Worst unrealised loss this position has seen","warmup":"absent while flat"},
+  "pos.maxProfit": {"summary":"Best unrealised profit this position has seen","warmup":"absent while flat"},
+  "pos.netProfit": {"summary":"Realised profit since the run began","warmup":"bar 0"},
+  "pos.openProfit": {"summary":"Unrealised profit in money, at this bar's close","warmup":"absent while flat"},
+  "pos.openProfitPercent": {"summary":"The same as a percentage of the position's cost","warmup":"absent while flat"},
+  "pos.profitFactor": {"summary":"Gross profit over gross loss","warmup":"bar 0"},
+  "pos.size": {"summary":"Net position in units, positive long and negative short","warmup":"bar 0, `0` when flat"},
+  "pos.tradeCount": {"summary":"Closed trades so far","warmup":"bar 0"},
+  "pos.winRate": {"summary":"Share of closed trades that made money","warmup":"bar 0"},
+  "pow": {"summary":"`x` to the power `y`, `none` where the result is not a finite real"},
+  "ppo": {"summary":"`[ppo, signal, histogram]`; the same gap as a percentage, so two instruments compare","warmup":"as `macd`"},
+  "print": {"summary":"Write a value to the script's log with the bar's time"},
+  "psar": {"summary":"`[sar, direction]`; a stop that accelerates toward price, seeded from bar 0's range","warmup":"element 0 at bar 1, element 1 at bar 1"},
+  "push": {"summary":"Append"},
+  "pvi": {"summary":"Cumulative change on bars where volume rose","warmup":"bar 1"},
+  "pvt": {"summary":"Running total of volume weighted by percentage change","warmup":"bar 1, seeded 0"},
+  "relativeVolume": {"summary":"This bar's volume over its own recent average","warmup":"bar `len - 1`"},
+  "remove": {"summary":"Remove and return element `i`"},
+  "req.candle": {"summary":"The whole higher timeframe bar at once, for drawing it","warmup":"as above"},
+  "req.error": {"summary":"The reason a read failed, or `\"\"`","warmup":"bar 0"},
+  "req.events": {"summary":"Dividends, splits and other scheduled events","warmup":"host dependent"},
+  "req.isReady": {"summary":"Whether the host has answered yet","warmup":"bar 0"},
+  "req.symbol": {"summary":"Read an expression computed on another instrument","warmup":"as above, plus the host's answer"},
+  "req.timeframe": {"summary":"Read an expression computed on a coarser interval","warmup":"first bar the mode allows, section 15.3"},
+  "reverse": {"summary":"In place"},
+  "rgb": {"summary":"Channels 0 to 255, fully opaque"},
+  "rgba": {"summary":"The same with alpha 0 to 1, where 1 is opaque"},
+  "rising": {"summary":"True when each of the last `len` changes was positive","warmup":"bar `len`"},
+  "rma": {"summary":"Smoothed mean with weight `1 / len`, seeded like `ema`; the smoothing the classic oscillators use","warmup":"bar `len - 1`"},
+  "roc": {"summary":"The same change as a percentage of the older value","warmup":"bar `len`"},
+  "round": {"summary":"To the nearest whole number, halves away from zero"},
+  "roundToStep": {"summary":"To the nearest multiple of `step`"},
+  "roundToTick": {"summary":"To the instrument's tick, `none` when `chart.tickSize` is absent"},
+  "rsi": {"summary":"0 to 100 reading of how one-sided the last `len` changes were","warmup":"bar `len`"},
+  "rvi": {"summary":"`[rvi, signal]`; where the close sits inside the bar, smoothed","warmup":"bar `len + 3`"},
+  "sell": {"summary":"Enter or add to a short position in one leg"},
+  "session.barIndex": {"summary":"This bar's position within its session, first is 0","warmup":"bar 0"},
+  "session.endTime": {"summary":"When this bar's session is scheduled to close","warmup":"the session's first bar"},
+  "session.isFirstBar": {"summary":"This is the session's first bar","warmup":"bar 0"},
+  "session.isHoliday": {"summary":"Whether a date is a trading holiday, once a calendar is supplied","warmup":"n/a"},
+  "session.isIn": {"summary":"Whether the bar falls in a stated window, section 12.5","warmup":"bar 0"},
+  "session.isLastBar": {"summary":"This is the session's last bar","warmup":"bar 0"},
+  "session.isOpen": {"summary":"This bar falls inside the instrument's trading session","warmup":"bar 0"},
+  "session.nextOpen": {"summary":"When the next session opens","warmup":"bar 0"},
+  "session.startTime": {"summary":"When this bar's session opened","warmup":"the session's first bar"},
+  "set": {"summary":"Write element `i`"},
+  "shift": {"summary":"Remove and return the first element"},
+  "sign": {"summary":"`-1`, `0` or `1`"},
+  "signal": {"summary":"A named marker on this bar"},
+  "size": {"summary":"Element count"},
+  "slice": {"summary":"A new array, `from` inclusive, `to` exclusive"},
+  "sma": {"summary":"Arithmetic mean of the last `len` values","warmup":"bar `len - 1`"},
+  "sort": {"summary":"In place, `\"asc\"` or `\"desc\"`"},
+  "sqrt": {"summary":"Square root, `none` below zero"},
+  "stdev": {"summary":"Standard deviation over the window, population by default","warmup":"bar `len - 1`"},
+  "stoch": {"summary":"`[k, d]`; where the close sits inside the window's range","warmup":"element 0 at bar `len + smoothK - 2`, element 1 at bar `len + smoothK + smoothD - 3`"},
+  "stochRsi": {"summary":"`[k, d]`; the same position test applied to `rsi` instead of price","warmup":"element 0 at bar `rsiLen + stochLen + smoothK - 2`"},
+  "str.contains": {"summary":"Whether one string appears in another"},
+  "str.endsWith": {"summary":"Suffix test"},
+  "str.format": {"summary":"Substitution into a template"},
+  "str.indexOf": {"summary":"First position of `part`, or `-1`"},
+  "str.join": {"summary":"Join an array back into one string"},
+  "str.length": {"summary":"Count of Unicode code points"},
+  "str.lower": {"summary":"Lower case, on the same terms"},
+  "str.match": {"summary":"Pattern matching, once a pattern syntax is specified"},
+  "str.padLeft": {"summary":"Pad to a width, for a table column that must line up"},
+  "str.padRight": {"summary":"The same from the other side"},
+  "str.repeat": {"summary":"`n` copies, for a bar drawn out of characters in a table cell"},
+  "str.replace": {"summary":"First occurrence only"},
+  "str.replaceAll": {"summary":"Every occurrence"},
+  "str.split": {"summary":"Split into parts"},
+  "str.startsWith": {"summary":"Prefix test"},
+  "str.substring": {"summary":"`from` inclusive, `to` exclusive, to the end when `to` is absent"},
+  "str.trim": {"summary":"Leading and trailing spaces removed"},
+  "str.upper": {"summary":"Upper case, invariant, not locale dependent"},
+  "sum": {"summary":"Total over the window","warmup":"bar `len - 1`"},
+  "sumSkip": {"summary":"Total over the window, ignoring absent bars","warmup":"bar `len - 1`"},
+  "supertrend": {"summary":"`[line, direction]`; a trailing band from average true range, `direction` is `-1` long or `1` short","warmup":"element 0 at bar `atrLen`, element 1 at bar `atrLen`"},
+  "swma": {"summary":"Fixed four bar symmetric mean, weights 1, 2, 2, 1 divided by 6","warmup":"bar 3"},
+  "table": {"summary":"Declare a grid pinned to a corner of the pane"},
+  "tema": {"summary":"Triple exponential mean, the same correction applied twice","warmup":"bar `3 * len - 3`"},
+  "text": {"summary":"Any value to a string; `text(none)` is `\"none\"`"},
+  "time": {"summary":"The bar's opening instant, UTC milliseconds","warmup":"bar 0"},
+  "timeClose": {"summary":"The instant the bar's interval ends","warmup":"bar 0"},
+  "toBool": {"summary":"`none` to `false`, a bool to itself; numbers are rejected"},
+  "toNumber": {"summary":"A string to a number, `none` when it does not parse"},
+  "trix": {"summary":"Rate of change of a triple exponential mean","warmup":"bar `3 * len - 2`"},
+  "trueRange": {"summary":"The bar's range including any gap from the previous close","warmup":"bar 0"},
+  "trunc": {"summary":"Toward zero"},
+  "tsi": {"summary":"Double smoothed momentum, so the noise of `mom` is gone","warmup":"bar `longLen + shortLen - 1`"},
+  "ultimateOsc": {"summary":"Buying pressure blended over three windows so one length cannot dominate","warmup":"bar `max(len1, len2, len3)`"},
+  "unshift": {"summary":"Insert at the front"},
+  "valueWhen": {"summary":"`src` as it stood the last time the condition held, or the one before that","warmup":"the `occurrence + 1` th true bar"},
+  "variance": {"summary":"The square of the same","warmup":"bar `len - 1`"},
+  "vidya": {"summary":"Mean whose smoothing follows relative volatility","warmup":"bar `2 * len - 1`"},
+  "volume": {"summary":"Quantity traded in the bar, absent where the host supplies none","warmup":"bar 0"},
+  "volumeProfile": {"summary":"Volume by price level, for a histogram drawn sideways","warmup":"the anchor bar"},
+  "vwap": {"summary":"Volume weighted average price since the session opened","warmup":"the session's first bar"},
+  "vwapAnchor": {"summary":"The same average, restarted on any bar the condition is true","warmup":"the first bar `resetWhen` is true"},
+  "vwma": {"summary":"Mean weighted by each bar's volume","warmup":"bar `len - 1`"},
+  "williamsR": {"summary":"Position in the window's range, scaled 0 to -100","warmup":"bar `len - 1`"},
+  "withAlpha": {"summary":"The same colour at a stated alpha"},
+  "wma": {"summary":"Linearly weighted mean, newest value weighted `len`","warmup":"bar `len - 1`"},
+  "zigzag": {"summary":"Swing points confirmed by a percentage reversal","warmup":"first confirmed swing"},
+  "zlema": {"summary":"Exponential mean with its lag removed by displacement","warmup":"bar `len - 1`"},
+};