Best Practices - kScript FAQ

Code Structure

Fundamental patterns for organizing your kScript code.

✓

Variable Declarations

Use the appropriate variable type for your data.

Static variables for constants:

Use for constants and values that never change across bars (e.g., periods, thresholds, multipliers).

Regular variables for dynamic values:

Use for dynamic values that change per bar but don't need historical access (e.g., signals, calculations).

Timeseries for historical data:

Use only when absolutely necessary as they consume more memory. Declare as timeseries when you need to:

Store data source outputs: timeseries price_data = ohlcv(...)
Access past values at previous candle indices: sma_values[5]

While indicator functions like sma(), ema(), and rsi() require a timeseries as input, their return values should be stored as var unless you specifically need to access historical values (e.g., sma_values[5]). This saves memory and improves performance.

Technical Indicators

Guidelines for working with technical indicators effectively.

✓

Explicit Parameters

Always specify parameters explicitly for clarity. This makes your code more readable and maintainable.

✓

Historical Data Access

Use bracket notation to access historical values safely.

Plotting & Visualization

Create clear and informative visualizations.

✓

Descriptive Plots

Use meaningful colors and widths to make your plots easy to distinguish.

✓

Choose Appropriate Plot Types

Select the right plot function for your data type.

💡 Plot Types

plotLine() for continuous lines
plotBar() for histogram data
plotCandle() for OHLC data
plotShape() for discrete signals

Debugging

Best practices for debugging and inspecting your kScript code.

✓

Use printTimeSeries for Timeseries Objects

Always use printTimeSeries() for timeseries objects instead of print(). The print() function only outputs the first value (e.g., only "open" for OHLCV data), while printTimeSeries() displays the complete timeseries structure.

Error Prevention

Protect your code against common runtime errors.

⚠️

Null Checking

Always check for invalid data before performing calculations.

⚠️

Division by Zero

Protect against division by zero errors.

⚠️

Array Bounds

Be careful when accessing historical data to avoid index errors.

Performance Optimization

Write efficient code that executes quickly.

✓

Avoid Redundant Calculations

Store frequently used calculations in variables instead of recalculating.

✓

Use Static Variables

Declare constants as static to avoid unnecessary recalculation on every bar.

Code Organization

Structure your code for maximum readability and maintainability.

✓

Organize your code into logical sections: inputs, data sources, calculations, signals, and plotting.

✓

Use Comments Effectively

Write clear comments that explain the "why" behind your code logic.

✓

Use Descriptive Labels and Descriptions

Always include label and desc parameters in your plotting functions. These parameters improve autocomplete functionality, make scripts more readable, and help with script organization in the editor.