Skip to content

Commit ed095ba

Browse files
committed
Readme + docs update
1 parent 52765c6 commit ed095ba

30 files changed

+1190
-392
lines changed

.github/badges/api-builtin.svg

Lines changed: 4 additions & 4 deletions
Loading

.github/badges/api-plots.svg

Lines changed: 14 additions & 0 deletions
Loading

.github/badges/coverage.svg

Lines changed: 4 additions & 4 deletions
Loading

README.md

Lines changed: 33 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -19,37 +19,41 @@ PineTS makes it possible to migrate Pine Script v5+ indicators to Javascript/Typ
1919

2020
### Data
2121

22-
[![syminfo](./.github/badges/api-syminfo.svg)](./.github/badges/api-syminfo.svg)
23-
[![session](./.github/badges/api-session.svg)](./.github/badges/api-session.svg)
24-
[![timeframe](./.github/badges/api-timeframe.svg)](./.github/badges/api-timeframe.svg)
25-
[![barstate](./.github/badges/api-barstate.svg)](./.github/badges/api-barstate.svg)
26-
[![ticker](./.github/badges/api-ticker.svg)](./.github/badges/api-ticker.svg)
27-
[![builtin](./.github/badges/api-builtin.svg)](./.github/badges/api-builtin.svg)
22+
[![syminfo](./.github/badges/api-syminfo.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/syminfo.html)
23+
[![session](./.github/badges/api-session.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/session.html)
24+
[![timeframe](./.github/badges/api-timeframe.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/timeframe.html)
25+
[![barstate](./.github/badges/api-barstate.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/barstate.html)
26+
[![ticker](./.github/badges/api-ticker.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/ticker.html)
27+
[![builtin](./.github/badges/api-builtin.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/builtin.html)
2828

2929
### Calculation
3030

31-
[![ta](./.github/badges/api-ta.svg)](./.github/badges/api-ta.svg)
32-
[![math](./.github/badges/api-math.svg)](./.github/badges/api-math.svg)
33-
[![array](./.github/badges/api-array.svg)](./.github/badges/api-array.svg)
34-
[![map](./.github/badges/api-map.svg)](./.github/badges/api-map.svg)
35-
[![matrix](./.github/badges/api-matrix.svg)](./.github/badges/api-matrix.svg)
36-
[![request](./.github/badges/api-request.svg)](./.github/badges/api-request.svg)
37-
[![types](./.github/badges/api-types.svg)](./.github/badges/api-types.svg)
38-
[![strategy](./.github/badges/api-strategy.svg)](./.github/badges/api-strategy.svg)
39-
[![input](./.github/badges/api-input.svg)](./.github/badges/api-input.svg)
40-
41-
### Drawing and Logging
42-
43-
[![str](./.github/badges/api-str.svg)](./.github/badges/api-str.svg)
44-
[![color](./.github/badges/api-color.svg)](./.github/badges/api-color.svg)
45-
[![chart](./.github/badges/api-chart.svg)](./.github/badges/api-chart.svg)
46-
[![log](./.github/badges/api-log.svg)](./.github/badges/api-log.svg)
47-
[![label](./.github/badges/api-label.svg)](./.github/badges/api-label.svg)
48-
[![line](./.github/badges/api-line.svg)](./.github/badges/api-line.svg)
49-
[![polyline](./.github/badges/api-polyline.svg)](./.github/badges/api-polyline.svg)
50-
[![box](./.github/badges/api-box.svg)](./.github/badges/api-box.svg)
51-
[![table](./.github/badges/api-table.svg)](./.github/badges/api-table.svg)
52-
[![linefill](./.github/badges/api-linefill.svg)](./.github/badges/api-linefill.svg)
31+
[![ta](./.github/badges/api-ta.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/ta.html)
32+
[![math](./.github/badges/api-math.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/math.html)
33+
[![array](./.github/badges/api-array.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/array.html)
34+
[![map](./.github/badges/api-map.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/map.html)
35+
[![matrix](./.github/badges/api-matrix.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/matrix.html)
36+
[![request](./.github/badges/api-request.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/request.html)
37+
[![types](./.github/badges/api-types.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/types.html)
38+
[![strategy](./.github/badges/api-strategy.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/strategy.html)
39+
[![input](./.github/badges/api-input.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/input.html)
40+
41+
### Visualization
42+
43+
[![color](./.github/badges/api-color.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/color.html)
44+
[![plots](./.github/badges/api-plots.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/plots.html)
45+
[![chart](./.github/badges/api-chart.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/chart.html)
46+
[![label](./.github/badges/api-label.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/label.html)
47+
[![line](./.github/badges/api-line.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/line.html)
48+
[![polyline](./.github/badges/api-polyline.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/polyline.html)
49+
[![box](./.github/badges/api-box.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/box.html)
50+
[![table](./.github/badges/api-table.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/table.html)
51+
[![linefill](./.github/badges/api-linefill.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/linefill.html)
52+
53+
### Logging
54+
55+
[![log](./.github/badges/api-log.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/log.html)
56+
[![str](./.github/badges/api-str.svg)](https://quantforgeorg.github.io/PineTS/api-coverage/str.html)
5357

5458
---
5559

@@ -107,7 +111,7 @@ npm install pinets
107111

108112
Original Pine Script:
109113

110-
<table>
114+
<table width="100%">
111115
<tr>
112116
<td>
113117

docs/api-coverage/array.md

Lines changed: 67 additions & 52 deletions
Original file line numberDiff line numberDiff line change
@@ -6,87 +6,102 @@ parent: API Coverage
66

77
## Array
88

9-
### Creation
9+
### Creation & Initialization
1010

1111
| Function | Status | Description |
1212
| ---------------------- | ------ | ---------------------------- |
13-
| `array.new_bool()` | ✔️ | Create boolean array |
13+
| `array.copy()` || Create copy of array |
14+
| `array.from()` || Create array from arguments |
15+
| `array.new_bool()` || Create boolean array |
1416
| `array.new_box()` | | Create box array |
1517
| `array.new_color()` | | Create color array |
16-
| `array.new_float()` | ✔️ | Create float array |
17-
| `array.new_int()` | ✔️ | Create int array |
18+
| `array.new_float()` | | Create float array |
19+
| `array.new_int()` | | Create int array |
1820
| `array.new_label()` | | Create label array |
1921
| `array.new_line()` | | Create line array |
2022
| `array.new_linefill()` | | Create linefill array |
21-
| `array.new_string()` | ✔️ | Create string array |
23+
| `array.new_string()` | | Create string array |
2224
| `array.new_table()` | | Create table array |
23-
| `array.new<type>()` | ✔️ | Create typed array (generic) |
24-
| `array.from()` || Create array from arguments |
25-
| `array.copy()` || Create copy of array |
25+
| `array.new<type>()` || Create typed array (generic) |
2626

27-
### Stack & Queue Operations
27+
### Element Access
28+
29+
| Function | Status | Description |
30+
| --------------- | ------ | ------------------ |
31+
| `array.first()` || Get first element |
32+
| `array.get()` || Get value at index |
33+
| `array.last()` || Get last element |
34+
| `array.set()` || Set value at index |
35+
36+
### Modification
2837

2938
| Function | Status | Description |
3039
| ----------------- | ------ | ---------------------------- |
31-
| `array.push()` || Append element to end |
32-
| `array.pop()` || Remove last element |
33-
| `array.unshift()` || Prepend element to beginning |
34-
| `array.shift()` || Remove first element |
40+
| `array.clear()` || Remove all elements |
41+
| `array.fill()` || Fill array with value |
3542
| `array.insert()` || Insert element at index |
43+
| `array.pop()` || Remove last element |
44+
| `array.push()` || Append element to end |
3645
| `array.remove()` || Remove element at index |
37-
| `array.clear()` || Remove all elements |
46+
| `array.reverse()` || Reverse order |
47+
| `array.shift()` || Remove first element |
48+
| `array.unshift()` || Prepend element to beginning |
3849

39-
### Access & Information
50+
### Size & Shape
4051

41-
| Function | Status | Description |
42-
| --------------- | ------ | --------------------- |
43-
| `array.get()` || Get value at index |
44-
| `array.set()` || Set value at index |
45-
| `array.first()` || Get first element |
46-
| `array.last()` || Get last element |
47-
| `array.fill()` || Fill array with value |
48-
| `array.size()` || Get array size |
52+
| Function | Status | Description |
53+
| ---------------- | ------ | ------------------ |
54+
| `array.concat()` || Concatenate arrays |
55+
| `array.size()` || Get array size |
56+
| `array.slice()` || Extract subarray |
4957

50-
### Search & Lookup
58+
### Search & Query
5159

5260
| Function | Status | Description |
5361
| --------------------------------- | ------ | ------------------------- |
54-
| `array.includes()` || Check if value exists |
55-
| `array.indexof()` || Find first index of value |
56-
| `array.lastindexof()` || Find last index of value |
5762
| `array.binary_search()` || Binary search |
5863
| `array.binary_search_leftmost()` || Binary search (leftmost) |
5964
| `array.binary_search_rightmost()` || Binary search (rightmost) |
65+
| `array.includes()` || Check if value exists |
66+
| `array.indexof()` || Find first index of value |
67+
| `array.lastindexof()` || Find last index of value |
68+
69+
### Statistical
6070

61-
### Calculations & Statistics
71+
| Function | Status | Description |
72+
| -------------------- | ------ | ------------------- |
73+
| `array.avg()` || Average of elements |
74+
| `array.covariance()` || Covariance |
75+
| `array.max()` || Maximum value |
76+
| `array.median()` || Median value |
77+
| `array.min()` || Minimum value |
78+
| `array.mode()` || Mode value |
79+
| `array.range()` || Range of values |
80+
| `array.stdev()` || Standard deviation |
81+
| `array.sum()` || Sum of elements |
82+
| `array.variance()` || Variance |
83+
84+
### Percentiles
6285

6386
| Function | Status | Description |
6487
| ----------------------------------------- | ------ | ------------------------- |
65-
| `array.sum()` || Sum of elements |
66-
| `array.avg()` || Average of elements |
67-
| `array.min()` || Minimum value |
68-
| `array.max()` || Maximum value |
69-
| `array.median()` || Median value |
70-
| `array.mode()` || Mode value |
71-
| `array.stdev()` || Standard deviation |
72-
| `array.variance()` || Variance |
73-
| `array.covariance()` || Covariance |
74-
| `array.standardize()` || Standardize elements |
75-
| `array.range()` || Range of values |
76-
| `array.abs()` || Absolute values |
77-
| `array.percentrank()` || Percentile rank |
7888
| `array.percentile_linear_interpolation()` || Percentile (Linear) |
7989
| `array.percentile_nearest_rank()` || Percentile (Nearest Rank) |
90+
| `array.percentrank()` || Percentile rank |
8091

81-
### Manipulation & Logic
92+
### Transformation
8293

83-
| Function | Status | Description |
84-
| ---------------------- | ------ | ---------------------------- |
85-
| `array.concat()` || Concatenate arrays |
86-
| `array.slice()` || Extract subarray |
87-
| `array.reverse()` || Reverse order |
88-
| `array.sort()` || Sort array |
89-
| `array.sort_indices()` || Get sorted indices |
90-
| `array.join()` || Join to string |
91-
| `array.every()` || Check if all elements match |
92-
| `array.some()` || Check if any element matches |
94+
| Function | Status | Description |
95+
| ---------------------- | ------ | -------------------- |
96+
| `array.abs()` || Absolute values |
97+
| `array.join()` || Join to string |
98+
| `array.sort()` || Sort array |
99+
| `array.sort_indices()` || Get sorted indices |
100+
| `array.standardize()` || Standardize elements |
101+
102+
### Logical
103+
104+
| Function | Status | Description |
105+
| --------------- | ------ | ---------------------------- |
106+
| `array.every()` || Check if all elements match |
107+
| `array.some()` || Check if any element matches |

docs/api-coverage/barstate.md

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,19 @@
1+
---
2+
layout: default
3+
title: Barstate
4+
parent: API Coverage
5+
---
6+
7+
## Barstate
8+
9+
### Bar State Flags
10+
11+
| Function | Status | Description |
12+
| --------------------------------- | ------ | ----------------------------- |
13+
| `barstate.isconfirmed` || Bar is confirmed |
14+
| `barstate.isfirst` || First bar of dataset |
15+
| `barstate.ishistory` || Bar is historical |
16+
| `barstate.islast` || Last bar of dataset |
17+
| `barstate.islastconfirmedhistory` || Last confirmed historical bar |
18+
| `barstate.isnew` || New bar |
19+
| `barstate.isrealtime` || Bar is real-time |

0 commit comments

Comments
 (0)