Skip to content

Commit

Permalink
docs: Fix broken links.
Browse files Browse the repository at this point in the history
  • Loading branch information
@jheer
jheer committed Jan 22, 2021
1 parent f07dba3 commit dd0a6dd
Show file tree
Hide file tree
Showing 3 changed files with 13 additions and 13 deletions.
4 changes: 2 additions & 2 deletions docs/api/index.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -80,7 +80,7 @@ aq.from({ a: 1, b: 2, c: 3 })
```

```js
// from a Map, create a new table with 'key' and 'value columns
// from a Map, create a new table with 'key' and 'value' columns
// akin to table({ key: ['d', 'e', 'f'], value: [4, 5, 6] })
aq.from(new Map([ ['d', 4], ['e', 5], ['f', 6] ])
```
Expand Down Expand Up @@ -270,7 +270,7 @@ Generate a table expression that computes the number of rows corresponding to a
aq.frac(0.5)
```
<a id="rolling" href="#rolling">#</a>
<hr/><a id="rolling" href="#rolling">#</a>
<em>aq</em>.<b>rolling</b>(<i>expr</i>[, <i>frame</i>, <i>includePeers</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/helpers/rolling.js)
Annotate a table expression to compute rolling aggregate or window functions within a sliding window frame. For example, to specify a rolling 7-day average centered on the current day, call *rolling* with a frame value of [-3, 3].
Expand Down
18 changes: 9 additions & 9 deletions docs/api/op.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,7 @@ Standard library of table expression functions. The [`op` object](./#op) exports
### <a id="array-functions">Array Functions</a>

<hr/><a id="concat" href="#concat">#</a>
<em>op</em>.<b>concat</b>(<i>...values</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/functions/sequence.js)
<em>op</em>.<b>concat</b>(<i>...values</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/functions/array.js)

Merges two or more arrays in sequence, returning a new array.

Expand Down Expand Up @@ -1041,14 +1041,14 @@ Window function to assign a percentage rank to each value in a group. The percen
Window function to assign a cumulative distribution value between 0 and 1 to each value in a group.

<hr/><a id="ntile" href="#ntile">#</a>
<em>op</em>.<b>ntile</b>(<i>num</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>ntile</b>(<i>num</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to assign a quantile (e.g., percentile) value to each value in a group. Accepts an integer parameter indicating the number of buckets to use (e.g., 100 for percentiles, 5 for quintiles).

* *num*: The number of buckets for ntile calculation.

<hr/><a id="lag" href="#lag">#</a>
<em>op</em>.<b>lag</b>(<i>field</i>[, <i>offset</i>, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>lag</b>(<i>field</i>[, <i>offset</i>, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to assign a value that precedes the current value by a specified number of positions. If no such value exists, returns a default value instead.

Expand All @@ -1057,7 +1057,7 @@ Window function to assign a value that precedes the current value by a specified
* *defaultValue*: The default value (default `undefined`).

<hr/><a id="lead" href="#lead">#</a>
<em>op</em>.<b>lead</b>(<i>field</i>[, <i>offset</i>, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>lead</b>(<i>field</i>[, <i>offset</i>, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to assign a value that follows the current value by a specified number of positions. If no such value exists, returns a default value instead.

Expand All @@ -1066,37 +1066,37 @@ Window function to assign a value that follows the current value by a specified
* *defaultValue*: The default value (default `undefined`).

<hr/><a id="first_value" href="#first_value">#</a>
<em>op</em>.<b>first_value</b>(<i>field</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>first_value</b>(<i>field</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to assign the first value in a sliding window frame.

* *field*: The data column or derived field.

<hr/><a id="last_value" href="#last_value">#</a>
<em>op</em>.<b>last_value</b>(<i>field</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>last_value</b>(<i>field</i>) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to assign the last value in a sliding window frame.

* *field*: The data column or derived field.

<hr/><a id="nth_value" href="#nth_value">#</a>
<em>op</em>.<b>nth_value</b>(<i>field</i>[, <i>nth</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>nth_value</b>(<i>field</i>[, <i>nth</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to assign the nth value in a sliding window frame (counting from 1), or `undefined` if no such value exists.

* *field*: The data column or derived field.
* *nth*: The nth position, starting from 1.

<hr/><a id="fill_down" href="#fill_down">#</a>
<em>op</em>.<b>fill_down</b>(<i>field</i>[, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>fill_down</b>(<i>field</i>[, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to fill in missing values with preceding values. Returns the value at the current window position if it is valid (not `null`, `undefined`, or `NaN`), otherwise returns the first preceding valid value. If no such value exists, returns the default value.

* *field*: The data column or derived field.
* *defaultValue*: The default value (default `undefined`).

<hr/><a id="fill_up" href="#fill_up">#</a>
<em>op</em>.<b>fill_up</b>(<i>field</i>[, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/verbs/index.js)
<em>op</em>.<b>fill_up</b>(<i>field</i>[, <i>defaultValue</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/op/window-functions.js)

Window function to fill in missing values with subsequent values. Returns the value at the current window position if it is valid (not `null`, `undefined`, or `NaN`), otherwise returns the first subsequent valid value. If no such value exists, returns the default value.

Expand Down
4 changes: 2 additions & 2 deletions docs/api/table.md
View file
Original file line number Diff line number Diff line change
Expand Up @@ -397,7 +397,7 @@ aq.table({ a: [1, 2, 3], b: [4, 5, 6] }).toCSV()
```

<hr/><a id="toHTML" href="#toHTML">#</a>
<em>table</em>.<b>toHTML</b>([<i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/format/to-csv.js)
<em>table</em>.<b>toHTML</b>([<i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/format/to-html.js)

Format this table as an HTML table string.

Expand Down Expand Up @@ -447,7 +447,7 @@ aq.table({ a: [1, 2, 3], b: [4, 5, 6] }).toJSON({ schema: false })
```

<hr/><a id="toMarkdown" href="#toMarkdown">#</a>
<em>table</em>.<b>toMarkdown</b>([<i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/format/to-json.js)
<em>table</em>.<b>toMarkdown</b>([<i>options</i>]) · [Source](https://github.com/uwdata/arquero/blob/master/src/format/to-markdown.js)

Format this table as a [GitHub-Flavored Markdown table](https://github.github.com/gfm/#tables-extension-) string.

Expand Down

0 comments on commit dd0a6dd

Please sign in to comment.