diff --git a/book/commands/dfr_agg.md b/book/commands/_agg.md similarity index 59% rename from book/commands/dfr_agg.md rename to book/commands/_agg.md index 7f18418f839..f6b4e88464b 100644 --- a/book/commands/dfr_agg.md +++ b/book/commands/_agg.md @@ -1,6 +1,6 @@ --- -title: dfr agg -version: 0.63.1 +title: agg +version: 0.64.0 usage: | Performs a series of aggregations from a group by --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr agg ...Group by expressions``` +```> agg ...Group by expressions``` ## Parameters @@ -27,24 +27,24 @@ usage: | Group by and perform an aggregation ```shell > [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr to-df - | dfr group-by a - | dfr agg [ - ("b" | dfr min | dfr as "b_min") - ("b" | dfr max | dfr as "b_max") - ("b" | dfr sum | dfr as "b_sum") + | to-df + | group-by a + | agg [ + (col b | min | as "b_min") + (col b | max | as "b_max") + (col b | sum | as "b_sum") ] ``` Group by and perform an aggregation ```shell > [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr to-lazy - | dfr group-by a - | dfr agg [ - ("b" | dfr min | dfr as "b_min") - ("b" | dfr max | dfr as "b_max") - ("b" | dfr sum | dfr as "b_sum") + | to-lazy + | group-by a + | agg [ + (col b | min | as "b_min") + (col b | max | as "b_max") + (col b | sum | as "b_sum") ] - | dfr collect + | collect ``` diff --git a/book/commands/dfr_all-false.md b/book/commands/_all-false.md similarity index 73% rename from book/commands/dfr_all-false.md rename to book/commands/_all-false.md index 5ba66a8a710..375bc432678 100644 --- a/book/commands/dfr_all-false.md +++ b/book/commands/_all-false.md @@ -1,6 +1,6 @@ --- -title: dfr all-false -version: 0.63.0 +title: all-false +version: 0.64.0 usage: | Returns true if all values are false --- @@ -16,18 +16,18 @@ usage: | ## Signature -```> dfr all-false ``` +```> all-false ``` ## Examples Returns true if all values are false ```shell -> [false false false] | dfr to-df | dfr all-false +> [false false false] | to-df | all-false ``` Checks the result from a comparison ```shell -> let s = ([5 6 2 10] | dfr to-df); +> let s = ([5 6 2 10] | to-df); let res = ($s > 9); - $res | dfr all-false + $res | all-false ``` diff --git a/book/commands/dfr_all-true.md b/book/commands/_all-true.md similarity index 74% rename from book/commands/dfr_all-true.md rename to book/commands/_all-true.md index 49ff6e05c22..9f7be70bc87 100644 --- a/book/commands/dfr_all-true.md +++ b/book/commands/_all-true.md @@ -1,6 +1,6 @@ --- -title: dfr all-true -version: 0.63.0 +title: all-true +version: 0.64.0 usage: | Returns true if all values are true --- @@ -16,18 +16,18 @@ usage: | ## Signature -```> dfr all-true ``` +```> all-true ``` ## Examples Returns true if all values are true ```shell -> [true true true] | dfr to-df | dfr all-true +> [true true true] | to-df | all-true ``` Checks the result from a comparison ```shell -> let s = ([5 6 2 8] | dfr to-df); +> let s = ([5 6 2 8] | to-df); let res = ($s > 9); - $res | dfr all-true + $res | all-true ``` diff --git a/book/commands/dfr_append.md b/book/commands/_append.md similarity index 72% rename from book/commands/dfr_append.md rename to book/commands/_append.md index 55bb39bf887..0c27b5d2471 100644 --- a/book/commands/dfr_append.md +++ b/book/commands/_append.md @@ -1,6 +1,6 @@ --- -title: dfr append -version: 0.63.0 +title: append +version: 0.64.0 usage: | Appends a new dataframe --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr append (other) --col``` +```> append (other) --col``` ## Parameters @@ -27,12 +27,12 @@ usage: | Appends a dataframe as new columns ```shell -> let a = ([[a b]; [1 2] [3 4]] | dfr to-df); - $a | dfr append $a +> let a = ([[a b]; [1 2] [3 4]] | to-df); + $a | append $a ``` Appends a dataframe merging at the end of columns ```shell -> let a = ([[a b]; [1 2] [3 4]] | dfr to-df); - $a | dfr append $a --col +> let a = ([[a b]; [1 2] [3 4]] | to-df); + $a | append $a --col ``` diff --git a/book/commands/dfr_arg-max.md b/book/commands/_arg-max.md similarity index 81% rename from book/commands/dfr_arg-max.md rename to book/commands/_arg-max.md index 79db1b5fd05..d1d8295cd1a 100644 --- a/book/commands/dfr_arg-max.md +++ b/book/commands/_arg-max.md @@ -1,6 +1,6 @@ --- -title: dfr arg-max -version: 0.63.0 +title: arg-max +version: 0.64.0 usage: | Return index for max value in series --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr arg-max ``` +```> arg-max ``` ## Examples Returns index for max value ```shell -> [1 3 2] | dfr to-df | dfr arg-max +> [1 3 2] | to-df | arg-max ``` diff --git a/book/commands/dfr_arg-min.md b/book/commands/_arg-min.md similarity index 81% rename from book/commands/dfr_arg-min.md rename to book/commands/_arg-min.md index 5656503742c..a93b0d2f5fb 100644 --- a/book/commands/dfr_arg-min.md +++ b/book/commands/_arg-min.md @@ -1,6 +1,6 @@ --- -title: dfr arg-min -version: 0.63.0 +title: arg-min +version: 0.64.0 usage: | Return index for min value in series --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr arg-min ``` +```> arg-min ``` ## Examples Returns index for min value ```shell -> [1 3 2] | dfr to-df | dfr arg-min +> [1 3 2] | to-df | arg-min ``` diff --git a/book/commands/dfr_arg-sort.md b/book/commands/_arg-sort.md similarity index 76% rename from book/commands/dfr_arg-sort.md rename to book/commands/_arg-sort.md index b6368dee81d..8ce06968e44 100644 --- a/book/commands/dfr_arg-sort.md +++ b/book/commands/_arg-sort.md @@ -1,6 +1,6 @@ --- -title: dfr arg-sort -version: 0.63.0 +title: arg-sort +version: 0.64.0 usage: | Returns indexes for a sorted series --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr arg-sort --reverse --nulls-last``` +```> arg-sort --reverse --nulls-last``` ## Parameters @@ -27,10 +27,10 @@ usage: | Returns indexes for a sorted series ```shell -> [1 2 2 3 3] | dfr to-df | dfr arg-sort +> [1 2 2 3 3] | to-df | arg-sort ``` Returns indexes for a sorted series ```shell -> [1 2 2 3 3] | dfr to-df | dfr arg-sort -r +> [1 2 2 3 3] | to-df | arg-sort -r ``` diff --git a/book/commands/dfr_arg-true.md b/book/commands/_arg-true.md similarity index 79% rename from book/commands/dfr_arg-true.md rename to book/commands/_arg-true.md index 3512bed8f4e..d15af243280 100644 --- a/book/commands/dfr_arg-true.md +++ b/book/commands/_arg-true.md @@ -1,6 +1,6 @@ --- -title: dfr arg-true -version: 0.63.0 +title: arg-true +version: 0.64.0 usage: | Returns indexes where values are true --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr arg-true ``` +```> arg-true ``` ## Examples Returns indexes where values are true ```shell -> [false true false] | dfr to-df | dfr arg-true +> [false true false] | to-df | arg-true ``` diff --git a/book/commands/dfr_arg-unique.md b/book/commands/_arg-unique.md similarity index 79% rename from book/commands/dfr_arg-unique.md rename to book/commands/_arg-unique.md index faab63e165c..1bb599c0e64 100644 --- a/book/commands/dfr_arg-unique.md +++ b/book/commands/_arg-unique.md @@ -1,6 +1,6 @@ --- -title: dfr arg-unique -version: 0.63.0 +title: arg-unique +version: 0.64.0 usage: | Returns indexes for unique values --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr arg-unique ``` +```> arg-unique ``` ## Examples Returns indexes for unique values ```shell -> [1 2 2 3 3] | dfr to-df | dfr arg-unique +> [1 2 2 3 3] | to-df | arg-unique ``` diff --git a/book/commands/dfr_as-date.md b/book/commands/_as-date.md similarity index 82% rename from book/commands/dfr_as-date.md rename to book/commands/_as-date.md index 8830713eb4e..8f4880d6891 100644 --- a/book/commands/dfr_as-date.md +++ b/book/commands/_as-date.md @@ -1,6 +1,6 @@ --- -title: dfr as-date -version: 0.63.0 +title: as-date +version: 0.64.0 usage: | Converts string to date. --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr as-date (format) --not-exact``` +```> as-date (format) --not-exact``` ## Parameters @@ -34,5 +34,5 @@ Format example: Converts string to date ```shell -> ["2021-12-30" "2021-12-31"] | dfr to-df | dfr as-datetime "%Y-%m-%d" +> ["2021-12-30" "2021-12-31"] | to-df | as-datetime "%Y-%m-%d" ``` diff --git a/book/commands/dfr_as-datetime.md b/book/commands/_as-datetime.md similarity index 86% rename from book/commands/dfr_as-datetime.md rename to book/commands/_as-datetime.md index a3a135bd0eb..55fbd02525f 100644 --- a/book/commands/dfr_as-datetime.md +++ b/book/commands/_as-datetime.md @@ -1,6 +1,6 @@ --- -title: dfr as-datetime -version: 0.63.0 +title: as-datetime +version: 0.64.0 usage: | Converts string to datetime. --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr as-datetime (format) --not-exact``` +```> as-datetime (format) --not-exact``` ## Parameters @@ -42,5 +42,5 @@ Format example: Converts string to datetime ```shell -> ["2021-12-30 00:00:00" "2021-12-31 00:00:00"] | dfr to-df | dfr as-datetime "%Y-%m-%d %H:%M:%S" +> ["2021-12-30 00:00:00" "2021-12-31 00:00:00"] | to-df | as-datetime "%Y-%m-%d %H:%M:%S" ``` diff --git a/book/commands/dfr_cache.md b/book/commands/_cache.md similarity index 72% rename from book/commands/dfr_cache.md rename to book/commands/_cache.md index 3c7d9a58ee3..72c72efc6a9 100644 --- a/book/commands/dfr_cache.md +++ b/book/commands/_cache.md @@ -1,6 +1,6 @@ --- -title: dfr cache -version: 0.63.0 +title: cache +version: 0.64.0 usage: | Caches operations in a new LazyFrame --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr cache ``` +```> cache ``` ## Examples - +Caches the result into a new LazyFrame ```shell -> +> [[a b]; [6 2] [4 2] [2 2]] | to-df | reverse | cache ``` diff --git a/book/commands/_collect.md b/book/commands/_collect.md new file mode 100644 index 00000000000..1e5d260edbb --- /dev/null +++ b/book/commands/_collect.md @@ -0,0 +1,26 @@ +--- +title: collect +version: 0.64.0 +usage: | + Collect lazy dataframe into eager dataframe +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> collect ``` + +## Examples + +drop duplicates +```shell +> [[a b]; [1 2] [3 4]] | to-lazy | collect +``` diff --git a/book/commands/dfr_concatenate.md b/book/commands/_concatenate.md similarity index 73% rename from book/commands/dfr_concatenate.md rename to book/commands/_concatenate.md index 7e117aabbfc..17c60839b60 100644 --- a/book/commands/dfr_concatenate.md +++ b/book/commands/_concatenate.md @@ -1,6 +1,6 @@ --- -title: dfr concatenate -version: 0.63.0 +title: concatenate +version: 0.64.0 usage: | Concatenates strings with other array --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr concatenate (other)``` +```> concatenate (other)``` ## Parameters @@ -26,6 +26,6 @@ usage: | Concatenate string ```shell -> let other = ([za xs cd] | dfr to-df); - [abc abc abc] | dfr to-df | dfr concatenate $other +> let other = ([za xs cd] | to-df); + [abc abc abc] | to-df | concatenate $other ``` diff --git a/book/commands/dfr_contains.md b/book/commands/_contains.md similarity index 81% rename from book/commands/dfr_contains.md rename to book/commands/_contains.md index a96f5835a32..49c6e7bbcff 100644 --- a/book/commands/dfr_contains.md +++ b/book/commands/_contains.md @@ -1,6 +1,6 @@ --- -title: dfr contains -version: 0.63.0 +title: contains +version: 0.64.0 usage: | Checks if a pattern is contained in a string --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr contains (pattern)``` +```> contains (pattern)``` ## Parameters @@ -26,5 +26,5 @@ usage: | Returns boolean indicating if pattern was found ```shell -> [abc acb acb] | dfr to-df | dfr contains ab +> [abc acb acb] | to-df | contains ab ``` diff --git a/book/commands/dfr_count-null.md b/book/commands/_count-null.md similarity index 73% rename from book/commands/dfr_count-null.md rename to book/commands/_count-null.md index 1d639372c5b..e895f941686 100644 --- a/book/commands/dfr_count-null.md +++ b/book/commands/_count-null.md @@ -1,6 +1,6 @@ --- -title: dfr count-null -version: 0.63.0 +title: count-null +version: 0.64.0 usage: | Counts null values --- @@ -16,12 +16,12 @@ usage: | ## Signature -```> dfr count-null ``` +```> count-null ``` ## Examples Counts null values ```shell -> let s = ([1 1 0 0 3 3 4] | dfr to-df); - ($s / $s) | dfr count-null +> let s = ([1 1 0 0 3 3 4] | to-df); + ($s / $s) | count-null ``` diff --git a/book/commands/dfr_cumulative.md b/book/commands/_cumulative.md similarity index 79% rename from book/commands/dfr_cumulative.md rename to book/commands/_cumulative.md index 26d7f417f78..203dcd62fd3 100644 --- a/book/commands/dfr_cumulative.md +++ b/book/commands/_cumulative.md @@ -1,6 +1,6 @@ --- -title: dfr cumulative -version: 0.63.0 +title: cumulative +version: 0.64.0 usage: | Cumulative calculation for a series --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr cumulative (type) --reverse``` +```> cumulative (type) --reverse``` ## Parameters @@ -27,5 +27,5 @@ usage: | Cumulative sum for a series ```shell -> [1 2 3 4 5] | dfr to-df | dfr cumulative sum +> [1 2 3 4 5] | to-df | cumulative sum ``` diff --git a/book/commands/dfr_describe.md b/book/commands/_describe.md similarity index 79% rename from book/commands/dfr_describe.md rename to book/commands/_describe.md index 28d9f327a5a..0471ecfa6e4 100644 --- a/book/commands/dfr_describe.md +++ b/book/commands/_describe.md @@ -1,6 +1,6 @@ --- -title: dfr describe -version: 0.63.0 +title: describe +version: 0.64.0 usage: | Describes dataframes numeric columns --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr describe --quantiles``` +```> describe --quantiles``` ## Parameters @@ -26,5 +26,5 @@ usage: | dataframe description ```shell -> [[a b]; [1 1] [1 1]] | dfr to-df | dfr describe +> [[a b]; [1 1] [1 1]] | to-df | describe ``` diff --git a/book/commands/dfr_collect.md b/book/commands/_df-not.md similarity index 72% rename from book/commands/dfr_collect.md rename to book/commands/_df-not.md index 5bb057ccf4e..fc470c1e304 100644 --- a/book/commands/dfr_collect.md +++ b/book/commands/_df-not.md @@ -1,8 +1,8 @@ --- -title: dfr collect -version: 0.63.0 +title: df-not +version: 0.64.0 usage: | - Collect lazy dataframe into dataframe + Inverts boolean mask --- + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> first (rows)``` + +## Parameters + + - `rows`: Number of rows for head + +## Examples + +Create new dataframe with head rows +```shell +> [[a b]; [1 2] [3 4]] | to-df | first 1 +``` diff --git a/book/commands/dfr_get-day.md b/book/commands/_get-day.md similarity index 79% rename from book/commands/dfr_get-day.md rename to book/commands/_get-day.md index a11576c64c4..4194cef8a44 100644 --- a/book/commands/dfr_get-day.md +++ b/book/commands/_get-day.md @@ -1,6 +1,6 @@ --- -title: dfr get-day -version: 0.63.0 +title: get-day +version: 0.64.0 usage: | Gets day from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-day ``` +```> get-day ``` ## Examples Returns day from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-day + let df = ([$dt $dt] | to-df); + $df | get-day ``` diff --git a/book/commands/dfr_get-hour.md b/book/commands/_get-hour.md similarity index 78% rename from book/commands/dfr_get-hour.md rename to book/commands/_get-hour.md index 55f675e16a5..a58a0a547ee 100644 --- a/book/commands/dfr_get-hour.md +++ b/book/commands/_get-hour.md @@ -1,6 +1,6 @@ --- -title: dfr get-hour -version: 0.63.0 +title: get-hour +version: 0.64.0 usage: | Gets hour from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-hour ``` +```> get-hour ``` ## Examples Returns hour from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-hour + let df = ([$dt $dt] | to-df); + $df | get-hour ``` diff --git a/book/commands/dfr_get-minute.md b/book/commands/_get-minute.md similarity index 78% rename from book/commands/dfr_get-minute.md rename to book/commands/_get-minute.md index 8db977e7681..2e866367cc7 100644 --- a/book/commands/dfr_get-minute.md +++ b/book/commands/_get-minute.md @@ -1,6 +1,6 @@ --- -title: dfr get-minute -version: 0.63.0 +title: get-minute +version: 0.64.0 usage: | Gets minute from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-minute ``` +```> get-minute ``` ## Examples Returns minute from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-minute + let df = ([$dt $dt] | to-df); + $df | get-minute ``` diff --git a/book/commands/dfr_get-month.md b/book/commands/_get-month.md similarity index 78% rename from book/commands/dfr_get-month.md rename to book/commands/_get-month.md index 92c7570ab73..1d257600378 100644 --- a/book/commands/dfr_get-month.md +++ b/book/commands/_get-month.md @@ -1,6 +1,6 @@ --- -title: dfr get-month -version: 0.63.0 +title: get-month +version: 0.64.0 usage: | Gets month from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-month ``` +```> get-month ``` ## Examples Returns month from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-month + let df = ([$dt $dt] | to-df); + $df | get-month ``` diff --git a/book/commands/dfr_get-nanosecond.md b/book/commands/_get-nanosecond.md similarity index 76% rename from book/commands/dfr_get-nanosecond.md rename to book/commands/_get-nanosecond.md index 80287d81799..60867807d01 100644 --- a/book/commands/dfr_get-nanosecond.md +++ b/book/commands/_get-nanosecond.md @@ -1,6 +1,6 @@ --- -title: dfr get-nanosecond -version: 0.63.0 +title: get-nanosecond +version: 0.64.0 usage: | Gets nanosecond from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-nanosecond ``` +```> get-nanosecond ``` ## Examples Returns nanosecond from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-nanosecond + let df = ([$dt $dt] | to-df); + $df | get-nanosecond ``` diff --git a/book/commands/dfr_get-ordinal.md b/book/commands/_get-ordinal.md similarity index 77% rename from book/commands/dfr_get-ordinal.md rename to book/commands/_get-ordinal.md index d041ddef58b..779d86a9e80 100644 --- a/book/commands/dfr_get-ordinal.md +++ b/book/commands/_get-ordinal.md @@ -1,6 +1,6 @@ --- -title: dfr get-ordinal -version: 0.63.0 +title: get-ordinal +version: 0.64.0 usage: | Gets ordinal from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-ordinal ``` +```> get-ordinal ``` ## Examples Returns ordinal from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-ordinal + let df = ([$dt $dt] | to-df); + $df | get-ordinal ``` diff --git a/book/commands/dfr_get-second.md b/book/commands/_get-second.md similarity index 78% rename from book/commands/dfr_get-second.md rename to book/commands/_get-second.md index cc8256b5f41..40f23301811 100644 --- a/book/commands/dfr_get-second.md +++ b/book/commands/_get-second.md @@ -1,6 +1,6 @@ --- -title: dfr get-second -version: 0.63.0 +title: get-second +version: 0.64.0 usage: | Gets second from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-second ``` +```> get-second ``` ## Examples Returns second from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-second + let df = ([$dt $dt] | to-df); + $df | get-second ``` diff --git a/book/commands/dfr_get-week.md b/book/commands/_get-week.md similarity index 78% rename from book/commands/dfr_get-week.md rename to book/commands/_get-week.md index d5fec298fbe..9ea76c33427 100644 --- a/book/commands/dfr_get-week.md +++ b/book/commands/_get-week.md @@ -1,6 +1,6 @@ --- -title: dfr get-week -version: 0.63.0 +title: get-week +version: 0.64.0 usage: | Gets week from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-week ``` +```> get-week ``` ## Examples Returns week from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-week + let df = ([$dt $dt] | to-df); + $df | get-week ``` diff --git a/book/commands/dfr_get-weekday.md b/book/commands/_get-weekday.md similarity index 77% rename from book/commands/dfr_get-weekday.md rename to book/commands/_get-weekday.md index ca47f1bef1a..4c337932243 100644 --- a/book/commands/dfr_get-weekday.md +++ b/book/commands/_get-weekday.md @@ -1,6 +1,6 @@ --- -title: dfr get-weekday -version: 0.63.0 +title: get-weekday +version: 0.64.0 usage: | Gets weekday from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-weekday ``` +```> get-weekday ``` ## Examples Returns weekday from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-weekday + let df = ([$dt $dt] | to-df); + $df | get-weekday ``` diff --git a/book/commands/dfr_get-year.md b/book/commands/_get-year.md similarity index 78% rename from book/commands/dfr_get-year.md rename to book/commands/_get-year.md index 5ce63a6255a..539fb1b092c 100644 --- a/book/commands/dfr_get-year.md +++ b/book/commands/_get-year.md @@ -1,6 +1,6 @@ --- -title: dfr get-year -version: 0.63.0 +title: get-year +version: 0.64.0 usage: | Gets year from date --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> dfr get-year ``` +```> get-year ``` ## Examples Returns year from a date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr get-year + let df = ([$dt $dt] | to-df); + $df | get-year ``` diff --git a/book/commands/dfr_get.md b/book/commands/_get.md similarity index 75% rename from book/commands/dfr_get.md rename to book/commands/_get.md index f526aa1ac5e..358a4638c52 100644 --- a/book/commands/dfr_get.md +++ b/book/commands/_get.md @@ -1,6 +1,6 @@ --- -title: dfr get -version: 0.63.0 +title: get +version: 0.64.0 usage: | Creates dataframe with the selected columns --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr get ...rest``` +```> get ...rest``` ## Parameters @@ -24,7 +24,7 @@ usage: | ## Examples -Creates dataframe with selected columns +Returns the selected column ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr get a +> [[a b]; [1 2] [3 4]] | to-df | get a ``` diff --git a/book/commands/dfr_group-by.md b/book/commands/_group-by.md similarity index 57% rename from book/commands/dfr_group-by.md rename to book/commands/_group-by.md index 74f8841be67..a613840b7b4 100644 --- a/book/commands/dfr_group-by.md +++ b/book/commands/_group-by.md @@ -1,6 +1,6 @@ --- -title: dfr group-by -version: 0.63.0 +title: group-by +version: 0.64.0 usage: | Creates a groupby object that can be used for other aggregations --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr group-by ...Group by expressions``` +```> group-by ...Group by expressions``` ## Parameters @@ -27,25 +27,24 @@ usage: | Group by and perform an aggregation ```shell > [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr to-df - | dfr group-by a - | dfr aggregate [ - ("b" | dfr min | dfr as "b_min") - ("b" | dfr max | dfr as "b_max") - ("b" | dfr sum | dfr as "b_sum") + | to-df + | group-by a + | agg [ + (col b | min | as "b_min") + (col b | max | as "b_max") + (col b | sum | as "b_sum") ] ``` Group by and perform an aggregation ```shell > [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr to-df - | dfr to-lazy - | dfr group-by a - | dfr aggregate [ - ("b" | dfr min | dfr as "b_min") - ("b" | dfr max | dfr as "b_max") - ("b" | dfr sum | dfr as "b_sum") + | to-lazy + | group-by a + | agg [ + (col b | min | as "b_min") + (col b | max | as "b_max") + (col b | sum | as "b_sum") ] - | dfr collect + | collect ``` diff --git a/book/commands/dfr_is-duplicated.md b/book/commands/_is-duplicated.md similarity index 77% rename from book/commands/dfr_is-duplicated.md rename to book/commands/_is-duplicated.md index 5bfc17809a7..93890009123 100644 --- a/book/commands/dfr_is-duplicated.md +++ b/book/commands/_is-duplicated.md @@ -1,6 +1,6 @@ --- -title: dfr is-duplicated -version: 0.63.0 +title: is-duplicated +version: 0.64.0 usage: | Creates mask indicating duplicated values --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr is-duplicated ``` +```> is-duplicated ``` ## Examples Create mask indicating duplicated values ```shell -> [5 6 6 6 8 8 8] | dfr to-df | dfr is-duplicated +> [5 6 6 6 8 8 8] | to-df | is-duplicated ``` diff --git a/book/commands/dfr_is-in.md b/book/commands/_is-in.md similarity index 77% rename from book/commands/dfr_is-in.md rename to book/commands/_is-in.md index f7790d9fe9a..25992dfa70a 100644 --- a/book/commands/dfr_is-in.md +++ b/book/commands/_is-in.md @@ -1,6 +1,6 @@ --- -title: dfr is-in -version: 0.63.0 +title: is-in +version: 0.64.0 usage: | Checks if elements from a series are contained in right series --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr is-in (other)``` +```> is-in (other)``` ## Parameters @@ -26,6 +26,6 @@ usage: | Checks if elements from a series are contained in right series ```shell -> let other = ([1 3 6] | dfr to-df); - [5 6 6 6 8 8 8] | dfr to-df | dfr is-in $other +> let other = ([1 3 6] | to-df); + [5 6 6 6 8 8 8] | to-df | is-in $other ``` diff --git a/book/commands/_is-not-null.md b/book/commands/_is-not-null.md new file mode 100644 index 00000000000..efc3ce47908 --- /dev/null +++ b/book/commands/_is-not-null.md @@ -0,0 +1,28 @@ +--- +title: is-not-null +version: 0.64.0 +usage: | + Creates mask where value is not null +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> is-not-null ``` + +## Examples + +Create mask where values are not null +```shell +> let s = ([5 6 0 8] | to-df); + let res = ($s / $s); + $res | is-not-null +``` diff --git a/book/commands/_is-null.md b/book/commands/_is-null.md new file mode 100644 index 00000000000..943fd494fc1 --- /dev/null +++ b/book/commands/_is-null.md @@ -0,0 +1,28 @@ +--- +title: is-null +version: 0.64.0 +usage: | + Creates mask where value is null +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> is-null ``` + +## Examples + +Create mask where values are null +```shell +> let s = ([5 6 0 8] | to-df); + let res = ($s / $s); + $res | is-null +``` diff --git a/book/commands/dfr_is-unique.md b/book/commands/_is-unique.md similarity index 79% rename from book/commands/dfr_is-unique.md rename to book/commands/_is-unique.md index 408587a1b1d..b3a901f823e 100644 --- a/book/commands/dfr_is-unique.md +++ b/book/commands/_is-unique.md @@ -1,6 +1,6 @@ --- -title: dfr is-unique -version: 0.63.0 +title: is-unique +version: 0.64.0 usage: | Creates mask indicating unique values --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr is-unique ``` +```> is-unique ``` ## Examples Create mask indicating unique values ```shell -> [5 6 6 6 8 8 8] | dfr to-df | dfr is-unique +> [5 6 6 6 8 8 8] | to-df | is-unique ``` diff --git a/book/commands/dfr_join.md b/book/commands/_join.md similarity index 69% rename from book/commands/dfr_join.md rename to book/commands/_join.md index 6c7e93fa57d..274e447e8ce 100644 --- a/book/commands/dfr_join.md +++ b/book/commands/_join.md @@ -1,6 +1,6 @@ --- -title: dfr join -version: 0.63.0 +title: join +version: 0.64.0 usage: | Joins a lazy frame with other lazy frame --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr join (other) (left_on) (right_on) --inner --left --outer --cross --suffix``` +```> join (other) (left_on) (right_on) --inner --left --outer --cross --suffix``` ## Parameters @@ -33,14 +33,14 @@ usage: | Join two lazy dataframes ```shell -> let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | dfr to-lazy); - let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [1 "c" "var"] [1 "c" "const"]] | dfr to-lazy); - $df_a | dfr join $df_b a foo | dfr collect +> let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | to-lazy); + let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [2 "c" "var"] [3 "c" "const"]] | to-lazy); + $df_a | join $df_b a foo | collect ``` Join one eager dataframe with a lazy dataframe ```shell -> let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | dfr to-df); - let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [1 "c" "var"] [1 "c" "const"]] | dfr to-lazy); - $df_a | dfr join $df_b a foo +> let df_a = ([[a b c];[1 "a" 0] [2 "b" 1] [1 "c" 2] [1 "c" 3]] | to-df); + let df_b = ([["foo" "bar" "ham"];[1 "a" "let"] [2 "c" "var"] [3 "c" "const"]] | to-lazy); + $df_a | join $df_b a foo ``` diff --git a/book/commands/dfr_last.md b/book/commands/_last.md similarity index 72% rename from book/commands/dfr_last.md rename to book/commands/_last.md index 7e402cc4e89..29afef60647 100644 --- a/book/commands/dfr_last.md +++ b/book/commands/_last.md @@ -1,6 +1,6 @@ --- -title: dfr last -version: 0.63.0 +title: last +version: 0.64.0 usage: | Creates new dataframe with tail rows or creates a last expression --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr last (rows)``` +```> last (rows)``` ## Parameters @@ -26,10 +26,5 @@ usage: | Create new dataframe with last rows ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr last 1 -``` - -Creates a last expression from a column -```shell -> dfr col a | dfr last +> [[a b]; [1 2] [3 4]] | to-df | last 1 ``` diff --git a/book/commands/dfr_ls.md b/book/commands/_ls-df.md similarity index 79% rename from book/commands/dfr_ls.md rename to book/commands/_ls-df.md index 8538c121429..b19c10ab1d2 100644 --- a/book/commands/dfr_ls.md +++ b/book/commands/_ls-df.md @@ -1,6 +1,6 @@ --- -title: dfr ls -version: 0.63.0 +title: ls-df +version: 0.64.0 usage: | Lists stored dataframes --- @@ -16,12 +16,12 @@ usage: | ## Signature -```> dfr ls ``` +```> ls-df ``` ## Examples Creates a new dataframe and shows it in the dataframe list ```shell -> let test = ([[a b];[1 2] [3 4]] | dfr to-df); - dfr ls +> let test = ([[a b];[1 2] [3 4]] | to-df); + ls-df ``` diff --git a/book/commands/_max.md b/book/commands/_max.md new file mode 100644 index 00000000000..4325a7d4f9a --- /dev/null +++ b/book/commands/_max.md @@ -0,0 +1,26 @@ +--- +title: max +version: 0.64.0 +usage: | + Aggregates columns to their max value +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> max ``` + +## Examples + +Max value from columns in a dataframe +```shell +> [[a b]; [6 2] [1 4] [4 1]] | to-df | max +``` diff --git a/book/commands/_mean.md b/book/commands/_mean.md new file mode 100644 index 00000000000..762eb032385 --- /dev/null +++ b/book/commands/_mean.md @@ -0,0 +1,26 @@ +--- +title: mean +version: 0.64.0 +usage: | + Aggregates columns to their mean value +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> mean ``` + +## Examples + +Mean value from columns in a dataframe +```shell +> [[a b]; [6 2] [4 2] [2 2]] | to-df | mean +``` diff --git a/book/commands/_median.md b/book/commands/_median.md new file mode 100644 index 00000000000..7541c71d3d1 --- /dev/null +++ b/book/commands/_median.md @@ -0,0 +1,26 @@ +--- +title: median +version: 0.64.0 +usage: | + Aggregates columns to their median value +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> median ``` + +## Examples + +Median value from columns in a dataframe +```shell +> [[a b]; [6 2] [4 2] [2 2]] | to-df | median +``` diff --git a/book/commands/dfr_melt.md b/book/commands/_melt.md similarity index 77% rename from book/commands/dfr_melt.md rename to book/commands/_melt.md index f1566ce6274..dbf9644ef2e 100644 --- a/book/commands/dfr_melt.md +++ b/book/commands/_melt.md @@ -1,6 +1,6 @@ --- -title: dfr melt -version: 0.63.0 +title: melt +version: 0.64.0 usage: | Unpivot a DataFrame from wide to long format --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr melt --columns --values --variable-name --value-name``` +```> melt --columns --values --variable-name --value-name``` ## Parameters @@ -29,5 +29,5 @@ usage: | melt dataframe ```shell -> [[a b c d]; [x 1 4 a] [y 2 5 b] [z 3 6 c]] | dfr to-df | dfr melt -c [b c] -v [a d] +> [[a b c d]; [x 1 4 a] [y 2 5 b] [z 3 6 c]] | to-df | melt -c [b c] -v [a d] ``` diff --git a/book/commands/_min.md b/book/commands/_min.md new file mode 100644 index 00000000000..9a7cef498a2 --- /dev/null +++ b/book/commands/_min.md @@ -0,0 +1,26 @@ +--- +title: min +version: 0.64.0 +usage: | + Aggregates columns to their min value +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> min ``` + +## Examples + +Min value from columns in a dataframe +```shell +> [[a b]; [6 2] [1 4] [4 1]] | to-df | min +``` diff --git a/book/commands/_n-unique.md b/book/commands/_n-unique.md new file mode 100644 index 00000000000..b0dd94bc6e0 --- /dev/null +++ b/book/commands/_n-unique.md @@ -0,0 +1,26 @@ +--- +title: n-unique +version: 0.64.0 +usage: | + Counts unique values +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> n-unique ``` + +## Examples + +Counts unique values +```shell +> [1 1 2 2 3 3 4] | to-df | n-unique +``` diff --git a/book/commands/dfr_open.md b/book/commands/_open-df.md similarity index 86% rename from book/commands/dfr_open.md rename to book/commands/_open-df.md index 62b40e3d653..c3453633a40 100644 --- a/book/commands/dfr_open.md +++ b/book/commands/_open-df.md @@ -1,6 +1,6 @@ --- -title: dfr open -version: 0.63.0 +title: open-df +version: 0.64.0 usage: | Opens csv, json or parquet file to create dataframe --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr open (file) --delimiter --no-header --infer-schema --skip-rows --columns``` +```> open-df (file) --delimiter --no-header --infer-schema --skip-rows --columns``` ## Parameters @@ -31,5 +31,5 @@ usage: | Takes a file name and creates a dataframe ```shell -> dfr open test.csv +> open test.csv ``` diff --git a/book/commands/dfr_quantile.md b/book/commands/_quantile.md similarity index 74% rename from book/commands/dfr_quantile.md rename to book/commands/_quantile.md index 8a09b81b058..834266b6746 100644 --- a/book/commands/dfr_quantile.md +++ b/book/commands/_quantile.md @@ -1,6 +1,6 @@ --- -title: dfr quantile -version: 0.63.0 +title: quantile +version: 0.64.0 usage: | Aggregates the columns to the selected quantile --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr quantile (quantile)``` +```> quantile (quantile)``` ## Parameters @@ -24,7 +24,7 @@ usage: | ## Examples - +quantile value from columns in a dataframe ```shell -> +> [[a b]; [6 2] [1 4] [4 1]] | to-df | quantile 0.5 ``` diff --git a/book/commands/dfr_rename-col.md b/book/commands/_rename.md similarity index 65% rename from book/commands/dfr_rename-col.md rename to book/commands/_rename.md index e5e9ebf24f6..37747b5020f 100644 --- a/book/commands/dfr_rename-col.md +++ b/book/commands/_rename.md @@ -1,6 +1,6 @@ --- -title: dfr rename-col -version: 0.63.0 +title: rename +version: 0.64.0 usage: | Rename a dataframe column --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr rename-col (columns) (new names)``` +```> rename (columns) (new names)``` ## Parameters @@ -25,7 +25,17 @@ usage: | ## Examples +Renames a series +```shell +> [5 6 7 8] | to-df | rename '0' new_name +``` + Renames a dataframe column ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr rename-col a a_new +> [[a b]; [1 2] [3 4]] | to-df | rename a a_new +``` + +Renames two dataframe columns +```shell +> [[a b]; [1 2] [3 4]] | to-df | rename [a b] [a_new b_new] ``` diff --git a/book/commands/dfr_replace-all.md b/book/commands/_replace-all.md similarity index 78% rename from book/commands/dfr_replace-all.md rename to book/commands/_replace-all.md index 1d31a0e12fa..147b823afd5 100644 --- a/book/commands/dfr_replace-all.md +++ b/book/commands/_replace-all.md @@ -1,6 +1,6 @@ --- -title: dfr replace-all -version: 0.63.0 +title: replace-all +version: 0.64.0 usage: | Replace all (sub)strings by a regex pattern --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr replace-all --pattern --replace``` +```> replace-all --pattern --replace``` ## Parameters @@ -27,5 +27,5 @@ usage: | Replaces string ```shell -> [abac abac abac] | dfr to-df | dfr replace-all -p a -r A +> [abac abac abac] | to-df | replace-all -p a -r A ``` diff --git a/book/commands/dfr_replace.md b/book/commands/_replace.md similarity index 79% rename from book/commands/dfr_replace.md rename to book/commands/_replace.md index 023e2d7b919..0ca540ac3fd 100644 --- a/book/commands/dfr_replace.md +++ b/book/commands/_replace.md @@ -1,6 +1,6 @@ --- -title: dfr replace -version: 0.63.0 +title: replace +version: 0.64.0 usage: | Replace the leftmost (sub)string by a regex pattern --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr replace --pattern --replace``` +```> replace --pattern --replace``` ## Parameters @@ -27,5 +27,5 @@ usage: | Replaces string ```shell -> [abc abc abc] | dfr to-df | dfr replace -p ab -r AB +> [abc abc abc] | to-df | replace -p ab -r AB ``` diff --git a/book/commands/dfr_reverse.md b/book/commands/_reverse.md similarity index 75% rename from book/commands/dfr_reverse.md rename to book/commands/_reverse.md index 2b93a351cce..5ee160ca710 100644 --- a/book/commands/dfr_reverse.md +++ b/book/commands/_reverse.md @@ -1,6 +1,6 @@ --- -title: dfr reverse -version: 0.63.0 +title: reverse +version: 0.64.0 usage: | Reverses the LazyFrame --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr reverse ``` +```> reverse ``` ## Examples - +Reverses the dataframe ```shell -> +> [[a b]; [6 2] [4 2] [2 2]] | to-df | reverse ``` diff --git a/book/commands/dfr_rolling.md b/book/commands/_rolling.md similarity index 72% rename from book/commands/dfr_rolling.md rename to book/commands/_rolling.md index 16abdba447c..ee2c91da045 100644 --- a/book/commands/dfr_rolling.md +++ b/book/commands/_rolling.md @@ -1,6 +1,6 @@ --- -title: dfr rolling -version: 0.63.0 +title: rolling +version: 0.64.0 usage: | Rolling calculation for a series --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr rolling (type) (window)``` +```> rolling (type) (window)``` ## Parameters @@ -27,10 +27,10 @@ usage: | Rolling sum for a series ```shell -> [1 2 3 4 5] | dfr to-df | dfr rolling sum 2 | dfr drop-nulls +> [1 2 3 4 5] | to-df | rolling sum 2 | drop-nulls ``` Rolling max for a series ```shell -> [1 2 3 4 5] | dfr to-df | dfr rolling max 2 | dfr drop-nulls +> [1 2 3 4 5] | to-df | rolling max 2 | drop-nulls ``` diff --git a/book/commands/dfr_sample.md b/book/commands/_sample.md similarity index 74% rename from book/commands/dfr_sample.md rename to book/commands/_sample.md index 816da53e0bb..98a6c6eb5e4 100644 --- a/book/commands/dfr_sample.md +++ b/book/commands/_sample.md @@ -1,6 +1,6 @@ --- -title: dfr sample -version: 0.63.0 +title: sample +version: 0.64.0 usage: | Create sample dataframe --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr sample --n-rows --fraction --seed --replace``` +```> sample --n-rows --fraction --seed --replace --shuffle``` ## Parameters @@ -24,15 +24,16 @@ usage: | - `--fraction {number}`: fraction of dataframe to be taken - `--seed {number}`: seed for the selection - `--replace`: sample with replace + - `--shuffle`: shuffle sample ## Examples Sample rows from dataframe ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr sample -n 1 +> [[a b]; [1 2] [3 4]] | to-df | sample -n 1 ``` Shows sample row using fraction and replace ```shell -> [[a b]; [1 2] [3 4] [5 6]] | dfr to-df | dfr sample -f 0.5 -e +> [[a b]; [1 2] [3 4] [5 6]] | to-df | sample -f 0.5 -e ``` diff --git a/book/commands/dfr_select.md b/book/commands/_select.md similarity index 62% rename from book/commands/dfr_select.md rename to book/commands/_select.md index 95c2dd084bc..04671bf7252 100644 --- a/book/commands/dfr_select.md +++ b/book/commands/_select.md @@ -1,6 +1,6 @@ --- -title: dfr select -version: 0.63.0 +title: select +version: 0.64.0 usage: | Selects columns from lazyframe --- @@ -16,15 +16,15 @@ usage: | ## Signature -```> dfr select (select expressions)``` +```> select ...select expressions``` ## Parameters - - `select expressions`: Expression(s) that define the column selection + - `...select expressions`: Expression(s) that define the column selection ## Examples - +Select a column from the dataframe ```shell -> +> [[a b]; [6 2] [4 2] [2 2]] | to-df | select a ``` diff --git a/book/commands/dfr_set-with-idx.md b/book/commands/_set-with-idx.md similarity index 71% rename from book/commands/dfr_set-with-idx.md rename to book/commands/_set-with-idx.md index d087c7a799d..b3e83b1936f 100644 --- a/book/commands/dfr_set-with-idx.md +++ b/book/commands/_set-with-idx.md @@ -1,6 +1,6 @@ --- -title: dfr set-with-idx -version: 0.63.0 +title: set-with-idx +version: 0.64.0 usage: | Sets value in the given index --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr set-with-idx (value) --indices``` +```> set-with-idx (value) --indices``` ## Parameters @@ -27,7 +27,7 @@ usage: | Set value in selected rows from series ```shell -> let series = ([4 1 5 2 4 3] | dfr to-df); - let indices = ([0 2] | dfr to-df); - $series | dfr set-with-idx 6 -i $indices +> let series = ([4 1 5 2 4 3] | to-df); + let indices = ([0 2] | to-df); + $series | set-with-idx 6 -i $indices ``` diff --git a/book/commands/dfr_set.md b/book/commands/_set.md similarity index 73% rename from book/commands/dfr_set.md rename to book/commands/_set.md index bf69b201562..56983b96fdc 100644 --- a/book/commands/dfr_set.md +++ b/book/commands/_set.md @@ -1,6 +1,6 @@ --- -title: dfr set -version: 0.63.0 +title: set +version: 0.64.0 usage: | Sets value where given mask is true --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr set (value) --mask``` +```> set (value) --mask``` ## Parameters @@ -27,7 +27,7 @@ usage: | Shifts the values by a given period ```shell -> let s = ([1 2 2 3 3] | dfr to-df | dfr shift 2); - let mask = ($s | dfr is-null); - $s | dfr set 0 --mask $mask +> let s = ([1 2 2 3 3] | to-df | shift 2); + let mask = ($s | is-null); + $s | set 0 --mask $mask ``` diff --git a/book/commands/dfr_shape.md b/book/commands/_shape.md similarity index 80% rename from book/commands/dfr_shape.md rename to book/commands/_shape.md index a4584f827b2..0ae263c19af 100644 --- a/book/commands/dfr_shape.md +++ b/book/commands/_shape.md @@ -1,6 +1,6 @@ --- -title: dfr shape -version: 0.63.0 +title: shape +version: 0.64.0 usage: | Shows column and row size for a dataframe --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr shape ``` +```> shape ``` ## Examples Shows row and column shape ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr shape +> [[a b]; [1 2] [3 4]] | to-df | shape ``` diff --git a/book/commands/dfr_shift.md b/book/commands/_shift.md similarity index 69% rename from book/commands/dfr_shift.md rename to book/commands/_shift.md index 4e79e8c9be4..239a51b6f5c 100644 --- a/book/commands/dfr_shift.md +++ b/book/commands/_shift.md @@ -1,6 +1,6 @@ --- -title: dfr shift -version: 0.63.0 +title: shift +version: 0.64.0 usage: | Shifts the values by a given period --- @@ -16,16 +16,16 @@ usage: | ## Signature -```> dfr shift (period) --fill``` +```> shift (period) --fill``` ## Parameters - `period`: shift period - - `--fill {any}`: Expression to use to fill the null values (lazy df) + - `--fill {any}`: Expression used to fill the null values (lazy df) ## Examples Shifts the values by a given period ```shell -> [1 2 2 3 3] | dfr to-df | dfr shift 2 | dfr drop-nulls +> [1 2 2 3 3] | to-df | shift 2 | drop-nulls ``` diff --git a/book/commands/dfr_slice.md b/book/commands/_slice.md similarity index 80% rename from book/commands/dfr_slice.md rename to book/commands/_slice.md index 2bc931c2fd0..595b7e0bb51 100644 --- a/book/commands/dfr_slice.md +++ b/book/commands/_slice.md @@ -1,6 +1,6 @@ --- -title: dfr slice -version: 0.63.0 +title: slice +version: 0.64.0 usage: | Creates new dataframe from a slice of rows --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr slice (offset) (size)``` +```> slice (offset) (size)``` ## Parameters @@ -27,5 +27,5 @@ usage: | Create new dataframe from a slice of the rows ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr slice 0 1 +> [[a b]; [1 2] [3 4]] | to-df | slice 0 1 ``` diff --git a/book/commands/dfr_sort-by.md b/book/commands/_sort-by.md similarity index 50% rename from book/commands/dfr_sort-by.md rename to book/commands/_sort-by.md index f4539aeebb8..496fce12f98 100644 --- a/book/commands/dfr_sort-by.md +++ b/book/commands/_sort-by.md @@ -1,6 +1,6 @@ --- -title: dfr sort-by -version: 0.63.0 +title: sort-by +version: 0.64.0 usage: | sorts a lazy dataframe based on expression(s) --- @@ -16,16 +16,21 @@ usage: | ## Signature -```> dfr sort-by (filter expression) --reverse``` +```> sort-by ...sort expression --reverse``` ## Parameters - - `filter expression`: filtering expression - - `--reverse {list}`: list indicating if reverse search should be done in the column. Default is false + - `...sort expression`: sort expression for the dataframe + - `--reverse {list}`: Reverse sorting. Default is false ## Examples +Sort dataframe by one column +```shell +> [[a b]; [6 2] [1 4] [4 1]] | to-df | sort-by a +``` +Sort column using two columns ```shell -> +> [[a b]; [6 2] [1 1] [1 4] [2 4]] | to-df | sort-by [a b] -r [false true] ``` diff --git a/book/commands/dfr_std.md b/book/commands/_std.md similarity index 75% rename from book/commands/dfr_std.md rename to book/commands/_std.md index a7528bfc7b5..3b2e1959098 100644 --- a/book/commands/dfr_std.md +++ b/book/commands/_std.md @@ -1,6 +1,6 @@ --- -title: dfr std -version: 0.63.0 +title: std +version: 0.64.0 usage: | Aggregates columns to their std value --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr std ``` +```> std ``` ## Examples - +Std value from columns in a dataframe ```shell -> +> [[a b]; [6 2] [4 2] [2 2]] | to-df | std ``` diff --git a/book/commands/dfr_str-lengths.md b/book/commands/_str-lengths.md similarity index 78% rename from book/commands/dfr_str-lengths.md rename to book/commands/_str-lengths.md index 5558ba9cf7c..ac7841537b5 100644 --- a/book/commands/dfr_str-lengths.md +++ b/book/commands/_str-lengths.md @@ -1,6 +1,6 @@ --- -title: dfr str-lengths -version: 0.63.0 +title: str-lengths +version: 0.64.0 usage: | Get lengths of all strings --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr str-lengths ``` +```> str-lengths ``` ## Examples Returns string lengths ```shell -> [a ab abc] | dfr to-df | dfr str-lengths +> [a ab abc] | to-df | str-lengths ``` diff --git a/book/commands/dfr_str-slice.md b/book/commands/_str-slice.md similarity index 79% rename from book/commands/dfr_str-slice.md rename to book/commands/_str-slice.md index 66395b10269..c6ce3444dd9 100644 --- a/book/commands/dfr_str-slice.md +++ b/book/commands/_str-slice.md @@ -1,6 +1,6 @@ --- -title: dfr str-slice -version: 0.63.0 +title: str-slice +version: 0.64.0 usage: | Slices the string from the start position until the selected length --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr str-slice (start) --length``` +```> str-slice (start) --length``` ## Parameters @@ -27,5 +27,5 @@ usage: | Creates slices from the strings ```shell -> [abcded abc321 abc123] | dfr to-df | dfr str-slice 1 -l 2 +> [abcded abc321 abc123] | to-df | str-slice 1 -l 2 ``` diff --git a/book/commands/dfr_strftime.md b/book/commands/_strftime.md similarity index 78% rename from book/commands/dfr_strftime.md rename to book/commands/_strftime.md index 78e769aa41a..d20896f4d23 100644 --- a/book/commands/dfr_strftime.md +++ b/book/commands/_strftime.md @@ -1,6 +1,6 @@ --- -title: dfr strftime -version: 0.63.0 +title: strftime +version: 0.64.0 usage: | Formats date based on string rule --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr strftime (fmt)``` +```> strftime (fmt)``` ## Parameters @@ -27,6 +27,6 @@ usage: | Formats date ```shell > let dt = ('2020-08-04T16:39:18+00:00' | into datetime -z 'UTC'); - let df = ([$dt $dt] | dfr to-df); - $df | dfr strftime "%Y/%m/%d" + let df = ([$dt $dt] | to-df); + $df | strftime "%Y/%m/%d" ``` diff --git a/book/commands/_sum.md b/book/commands/_sum.md new file mode 100644 index 00000000000..59720ba7258 --- /dev/null +++ b/book/commands/_sum.md @@ -0,0 +1,26 @@ +--- +title: sum +version: 0.64.0 +usage: | + Aggregates columns to their sum value +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> sum ``` + +## Examples + +Sums all columns in a dataframe +```shell +> [[a b]; [6 2] [1 4] [4 1]] | to-df | sum +``` diff --git a/book/commands/dfr_take.md b/book/commands/_take.md similarity index 64% rename from book/commands/dfr_take.md rename to book/commands/_take.md index ab5242f19bd..b2909c927cb 100644 --- a/book/commands/dfr_take.md +++ b/book/commands/_take.md @@ -1,6 +1,6 @@ --- -title: dfr take -version: 0.63.0 +title: take +version: 0.64.0 usage: | Creates new dataframe using the given indices --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr take (indices)``` +```> take (indices)``` ## Parameters @@ -26,14 +26,14 @@ usage: | Takes selected rows from dataframe ```shell -> let df = ([[a b]; [4 1] [5 2] [4 3]] | dfr to-df); - let indices = ([0 2] | dfr to-df); - $df | dfr take $indices +> let df = ([[a b]; [4 1] [5 2] [4 3]] | to-df); + let indices = ([0 2] | to-df); + $df | take $indices ``` Takes selected rows from series ```shell -> let series = ([4 1 5 2 4 3] | dfr to-df); - let indices = ([0 2] | dfr to-df); - $series | dfr take $indices +> let series = ([4 1 5 2 4 3] | to-df); + let indices = ([0 2] | to-df); + $series | take $indices ``` diff --git a/book/commands/dfr_to-csv.md b/book/commands/_to-csv.md similarity index 75% rename from book/commands/dfr_to-csv.md rename to book/commands/_to-csv.md index 66619caa469..fb96e79adba 100644 --- a/book/commands/dfr_to-csv.md +++ b/book/commands/_to-csv.md @@ -1,6 +1,6 @@ --- -title: dfr to-csv -version: 0.63.0 +title: to-csv +version: 0.64.0 usage: | Saves dataframe to csv file --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr to-csv (file) --delimiter --no-header``` +```> to-csv (file) --delimiter --no-header``` ## Parameters @@ -28,10 +28,10 @@ usage: | Saves dataframe to csv file ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr to-csv test.csv +> [[a b]; [1 2] [3 4]] | to-df | to-csv test.csv ``` Saves dataframe to csv file using other delimiter ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr to-csv test.csv -d '|' +> [[a b]; [1 2] [3 4]] | to-df | to-csv test.csv -d '|' ``` diff --git a/book/commands/dfr_to-df.md b/book/commands/_to-df.md similarity index 77% rename from book/commands/dfr_to-df.md rename to book/commands/_to-df.md index 07698947a20..bbf0361f5dc 100644 --- a/book/commands/dfr_to-df.md +++ b/book/commands/_to-df.md @@ -1,6 +1,6 @@ --- -title: dfr to-df -version: 0.63.0 +title: to-df +version: 0.64.0 usage: | Converts a List, Table or Dictionary into a dataframe --- @@ -16,26 +16,26 @@ usage: | ## Signature -```> dfr to-df ``` +```> to-df ``` ## Examples Takes a dictionary and creates a dataframe ```shell -> [[a b];[1 2] [3 4]] | dfr to-df +> [[a b];[1 2] [3 4]] | to-df ``` Takes a list of tables and creates a dataframe ```shell -> [[1 2 a] [3 4 b] [5 6 c]] | dfr to-df +> [[1 2 a] [3 4 b] [5 6 c]] | to-df ``` Takes a list and creates a dataframe ```shell -> [a b c] | dfr to-df +> [a b c] | to-df ``` Takes a list of booleans and creates a dataframe ```shell -> [true true false] | dfr to-df +> [true true false] | to-df ``` diff --git a/book/commands/dfr_to-dummies.md b/book/commands/_to-dummies.md similarity index 76% rename from book/commands/dfr_to-dummies.md rename to book/commands/_to-dummies.md index c527703e716..2698dcc899b 100644 --- a/book/commands/dfr_to-dummies.md +++ b/book/commands/_to-dummies.md @@ -1,6 +1,6 @@ --- -title: dfr to-dummies -version: 0.63.0 +title: to-dummies +version: 0.64.0 usage: | Creates a new dataframe with dummy variables --- @@ -16,16 +16,16 @@ usage: | ## Signature -```> dfr to-dummies ``` +```> to-dummies ``` ## Examples Create new dataframe with dummy variables from a dataframe ```shell -> [[a b]; [1 2] [3 4]] | dfr to-df | dfr to-dummies +> [[a b]; [1 2] [3 4]] | to-df | to-dummies ``` Create new dataframe with dummy variables from a series ```shell -> [1 2 2 3 3] | dfr to-df | dfr to-dummies +> [1 2 2 3 3] | to-df | to-dummies ``` diff --git a/book/commands/dfr_to-lazy.md b/book/commands/_to-lazy.md similarity index 80% rename from book/commands/dfr_to-lazy.md rename to book/commands/_to-lazy.md index 2daff66c61d..843e33f376a 100644 --- a/book/commands/dfr_to-lazy.md +++ b/book/commands/_to-lazy.md @@ -1,6 +1,6 @@ --- -title: dfr to-lazy -version: 0.63.0 +title: to-lazy +version: 0.64.0 usage: | Converts a dataframe into a lazy dataframe --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr to-lazy ``` +```> to-lazy ``` ## Examples Takes a dictionary and creates a lazy dataframe ```shell -> [[a b];[1 2] [3 4]] | dfr to-df | dfl to-lazy +> [[a b];[1 2] [3 4]] | to-lazy ``` diff --git a/book/commands/dfr_to-lowercase.md b/book/commands/_to-lowercase.md similarity index 77% rename from book/commands/dfr_to-lowercase.md rename to book/commands/_to-lowercase.md index 1b19732ae42..fc1f3330944 100644 --- a/book/commands/dfr_to-lowercase.md +++ b/book/commands/_to-lowercase.md @@ -1,6 +1,6 @@ --- -title: dfr to-lowercase -version: 0.63.0 +title: to-lowercase +version: 0.64.0 usage: | Lowercase the strings in the column --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr to-lowercase ``` +```> to-lowercase ``` ## Examples Modifies strings to lowercase ```shell -> [Abc aBc abC] | dfr to-df | dfr to-lowercase +> [Abc aBc abC] | to-df | to-lowercase ``` diff --git a/book/commands/dfr_first.md b/book/commands/_to-nu.md similarity index 51% rename from book/commands/dfr_first.md rename to book/commands/_to-nu.md index 4e3a869e0d9..921207306c1 100644 --- a/book/commands/dfr_first.md +++ b/book/commands/_to-nu.md @@ -1,8 +1,8 @@ --- -title: dfr first -version: 0.63.0 +title: to-nu +version: 0.64.0 usage: | - Creates new dataframe with first rows or creates a first expression + Converts a section of the dataframe to Nushell Table --- - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dataframe ``` diff --git a/book/commands/date.md b/book/commands/date.md index 119f844083f..153056a99d2 100644 --- a/book/commands/date.md +++ b/book/commands/date.md @@ -1,6 +1,6 @@ --- title: date -version: 0.63.0 +version: 0.64.0 usage: | Date-related commands --- diff --git a/book/commands/date_format.md b/book/commands/date_format.md index d47005b4ed6..313e6cc3f44 100644 --- a/book/commands/date_format.md +++ b/book/commands/date_format.md @@ -1,6 +1,6 @@ --- title: date format -version: 0.63.0 +version: 0.64.0 usage: | Format a given date using a format string. --- diff --git a/book/commands/date_humanize.md b/book/commands/date_humanize.md index 6eb1854f035..bb6332a0b09 100644 --- a/book/commands/date_humanize.md +++ b/book/commands/date_humanize.md @@ -1,6 +1,6 @@ --- title: date humanize -version: 0.63.0 +version: 0.64.0 usage: | Print a 'humanized' format for the date, relative to now. --- diff --git a/book/commands/date_list-timezone.md b/book/commands/date_list-timezone.md index fcbfbd78a20..1a91bf3fde5 100644 --- a/book/commands/date_list-timezone.md +++ b/book/commands/date_list-timezone.md @@ -1,6 +1,6 @@ --- title: date list-timezone -version: 0.63.0 +version: 0.64.0 usage: | List supported time zones. --- diff --git a/book/commands/date_now.md b/book/commands/date_now.md index dabe0313621..0ecb3439ac8 100644 --- a/book/commands/date_now.md +++ b/book/commands/date_now.md @@ -1,6 +1,6 @@ --- title: date now -version: 0.63.0 +version: 0.64.0 usage: | Get the current date. --- diff --git a/book/commands/date_to-record.md b/book/commands/date_to-record.md index d7534e49172..e3146cd7a04 100644 --- a/book/commands/date_to-record.md +++ b/book/commands/date_to-record.md @@ -1,6 +1,6 @@ --- title: date to-record -version: 0.63.0 +version: 0.64.0 usage: | Convert the date into a structured table. --- diff --git a/book/commands/date_to-table.md b/book/commands/date_to-table.md index 2fa23b1f39c..abe6fa2662b 100644 --- a/book/commands/date_to-table.md +++ b/book/commands/date_to-table.md @@ -1,6 +1,6 @@ --- title: date to-table -version: 0.63.0 +version: 0.64.0 usage: | Convert the date into a structured table. --- diff --git a/book/commands/date_to-timezone.md b/book/commands/date_to-timezone.md index b3a2fefb59b..ba088017a0e 100644 --- a/book/commands/date_to-timezone.md +++ b/book/commands/date_to-timezone.md @@ -1,6 +1,6 @@ --- title: date to-timezone -version: 0.63.0 +version: 0.64.0 usage: | Convert a date to a given time zone. --- diff --git a/book/commands/db.md b/book/commands/db.md index 98c6c230fe2..8d2e256ed68 100644 --- a/book/commands/db.md +++ b/book/commands/db.md @@ -1,6 +1,6 @@ --- title: db -version: 0.63.0 +version: 0.64.0 usage: | Database commands --- diff --git a/book/commands/db_and.md b/book/commands/db_and.md index 085ab63b001..6bd7ecc60bd 100644 --- a/book/commands/db_and.md +++ b/book/commands/db_and.md @@ -1,6 +1,6 @@ --- title: db and -version: 0.63.0 +version: 0.64.0 usage: | Includes an AND clause for a query or expression --- diff --git a/book/commands/db_as.md b/book/commands/db_as.md index 45598f0db0d..63360ab61d0 100644 --- a/book/commands/db_as.md +++ b/book/commands/db_as.md @@ -1,6 +1,6 @@ --- title: db as -version: 0.63.0 +version: 0.64.0 usage: | Creates an alias for a column selection --- diff --git a/book/commands/db_col.md b/book/commands/db_col.md index e2b0c22c587..5b29dae1145 100644 --- a/book/commands/db_col.md +++ b/book/commands/db_col.md @@ -1,6 +1,6 @@ --- title: db col -version: 0.63.0 +version: 0.64.0 usage: | Creates column expression for database --- diff --git a/book/commands/db_collect.md b/book/commands/db_collect.md index 2ef19514c51..06a25f0e673 100644 --- a/book/commands/db_collect.md +++ b/book/commands/db_collect.md @@ -1,6 +1,6 @@ --- title: db collect -version: 0.63.0 +version: 0.64.0 usage: | Query a database using SQL. --- diff --git a/book/commands/db_describe.md b/book/commands/db_describe.md index e2dbe0003b8..2f75721b6be 100644 --- a/book/commands/db_describe.md +++ b/book/commands/db_describe.md @@ -1,6 +1,6 @@ --- title: db describe -version: 0.63.0 +version: 0.64.0 usage: | Describes connection and query of the DB object --- diff --git a/book/commands/db_fn.md b/book/commands/db_fn.md index 2447242efc2..c0aae2f73f1 100644 --- a/book/commands/db_fn.md +++ b/book/commands/db_fn.md @@ -1,6 +1,6 @@ --- title: db fn -version: 0.63.0 +version: 0.64.0 usage: | Creates function expression for a select operation --- diff --git a/book/commands/db_from.md b/book/commands/db_from.md index 0b1b6c37fbd..bad41c67362 100644 --- a/book/commands/db_from.md +++ b/book/commands/db_from.md @@ -1,6 +1,6 @@ --- title: db from -version: 0.63.0 +version: 0.64.0 usage: | Select section from query statement for a DB --- diff --git a/book/commands/db_group-by.md b/book/commands/db_group-by.md index 69020ca312f..c3b65f3d63c 100644 --- a/book/commands/db_group-by.md +++ b/book/commands/db_group-by.md @@ -1,6 +1,6 @@ --- title: db group-by -version: 0.63.0 +version: 0.64.0 usage: | Group by query --- diff --git a/book/commands/db_join.md b/book/commands/db_join.md index f0898417204..0ca0508706a 100644 --- a/book/commands/db_join.md +++ b/book/commands/db_join.md @@ -1,6 +1,6 @@ --- title: db join -version: 0.63.0 +version: 0.64.0 usage: | Joins with another table or derived table. Default join type is inner --- diff --git a/book/commands/db_limit.md b/book/commands/db_limit.md index fb40048b5ed..4f23cbb711b 100644 --- a/book/commands/db_limit.md +++ b/book/commands/db_limit.md @@ -1,6 +1,6 @@ --- title: db limit -version: 0.63.0 +version: 0.64.0 usage: | Limit result from query --- diff --git a/book/commands/db_open.md b/book/commands/db_open.md index 8f2dff4bd1f..8303426826a 100644 --- a/book/commands/db_open.md +++ b/book/commands/db_open.md @@ -1,6 +1,6 @@ --- title: db open -version: 0.63.0 +version: 0.64.0 usage: | Open a database --- diff --git a/book/commands/db_or.md b/book/commands/db_or.md index a7b5de9b109..3acbd8d1b9e 100644 --- a/book/commands/db_or.md +++ b/book/commands/db_or.md @@ -1,6 +1,6 @@ --- title: db or -version: 0.63.0 +version: 0.64.0 usage: | Includes an OR clause for a query or expression --- diff --git a/book/commands/db_order-by.md b/book/commands/db_order-by.md index d0401e34ab4..986dd36bf09 100644 --- a/book/commands/db_order-by.md +++ b/book/commands/db_order-by.md @@ -1,6 +1,6 @@ --- title: db order-by -version: 0.63.0 +version: 0.64.0 usage: | Orders by query --- @@ -16,13 +16,13 @@ usage: | ## Signature -```> db order-by ...select --ascending --nulls_first``` +```> db order-by ...select --ascending --nulls-first``` ## Parameters - `...select`: Select expression(s) on the table - `--ascending`: Order by ascending values - - `--nulls_first`: Show nulls first in order + - `--nulls-first`: Show nulls first in order ## Examples diff --git a/book/commands/db_over.md b/book/commands/db_over.md index 3e4c021db1f..f74c47da15f 100644 --- a/book/commands/db_over.md +++ b/book/commands/db_over.md @@ -1,6 +1,6 @@ --- title: db over -version: 0.63.0 +version: 0.64.0 usage: | Adds a partition to an expression function --- diff --git a/book/commands/db_query.md b/book/commands/db_query.md index d93e2877c69..821ce838b57 100644 --- a/book/commands/db_query.md +++ b/book/commands/db_query.md @@ -1,6 +1,6 @@ --- title: db query -version: 0.63.0 +version: 0.64.0 usage: | Query a database using SQL. --- diff --git a/book/commands/db_schema.md b/book/commands/db_schema.md index 6371c863d73..f26dfbd7a1b 100644 --- a/book/commands/db_schema.md +++ b/book/commands/db_schema.md @@ -1,6 +1,6 @@ --- title: db schema -version: 0.63.0 +version: 0.64.0 usage: | Show database information, including its schema. --- diff --git a/book/commands/db_select.md b/book/commands/db_select.md index 7aeb38e2a2e..6bd4a0349a2 100644 --- a/book/commands/db_select.md +++ b/book/commands/db_select.md @@ -1,6 +1,6 @@ --- title: db select -version: 0.63.0 +version: 0.64.0 usage: | Creates a select statement for a DB --- diff --git a/book/commands/db_testing.md b/book/commands/db_testing.md index 33fa66894fe..0240a620002 100644 --- a/book/commands/db_testing.md +++ b/book/commands/db_testing.md @@ -1,6 +1,6 @@ --- title: db testing -version: 0.63.0 +version: 0.64.0 usage: | Create query object --- diff --git a/book/commands/db_where.md b/book/commands/db_where.md index 6d6f75be986..e8c3849ec6b 100644 --- a/book/commands/db_where.md +++ b/book/commands/db_where.md @@ -1,6 +1,6 @@ --- title: db where -version: 0.63.0 +version: 0.64.0 usage: | Includes a where statement for a query --- diff --git a/book/commands/debug.md b/book/commands/debug.md index c9adf5bdd4d..2cc66487d0d 100644 --- a/book/commands/debug.md +++ b/book/commands/debug.md @@ -1,6 +1,6 @@ --- title: debug -version: 0.63.0 +version: 0.64.0 usage: | Debug print the value(s) piped in. --- diff --git a/book/commands/decode.md b/book/commands/decode.md index d7704bc3cb6..401d032d3e0 100644 --- a/book/commands/decode.md +++ b/book/commands/decode.md @@ -1,6 +1,6 @@ --- title: decode -version: 0.63.0 +version: 0.64.0 usage: | Decode bytes as a string. --- diff --git a/book/commands/def-env.md b/book/commands/def-env.md index c07078f7aa3..1c3e874ebca 100644 --- a/book/commands/def-env.md +++ b/book/commands/def-env.md @@ -1,6 +1,6 @@ --- title: def-env -version: 0.63.0 +version: 0.64.0 usage: | Define a custom command, which participates in the caller environment --- @@ -26,8 +26,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/def.md b/book/commands/def.md index 4bcbf562830..ceb1d9f7267 100644 --- a/book/commands/def.md +++ b/book/commands/def.md @@ -1,6 +1,6 @@ --- title: def -version: 0.63.0 +version: 0.64.0 usage: | Define a custom command --- @@ -26,8 +26,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/default.md b/book/commands/default.md index caf58b54461..0dcdfacbd1d 100644 --- a/book/commands/default.md +++ b/book/commands/default.md @@ -1,6 +1,6 @@ --- title: default -version: 0.63.0 +version: 0.64.0 usage: | Sets a default row's column if missing. --- diff --git a/book/commands/describe.md b/book/commands/describe.md index 5246ed337df..951bff0819c 100644 --- a/book/commands/describe.md +++ b/book/commands/describe.md @@ -1,8 +1,8 @@ --- title: describe -version: 0.63.0 +version: 0.64.0 usage: | - Describe the value(s) piped in. + Describe the type and structure of the value(s) piped in. --- - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr ``` diff --git a/book/commands/dfr_aggregate.md b/book/commands/dfr_aggregate.md deleted file mode 100644 index 70eccb6ae09..00000000000 --- a/book/commands/dfr_aggregate.md +++ /dev/null @@ -1,51 +0,0 @@ ---- -title: dfr aggregate -version: 0.63.0 -usage: | - Performs a series of aggregations from a group by ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr aggregate ...Group by expressions``` - -## Parameters - - - `...Group by expressions`: Expression(s) that define the aggregations to be applied - -## Examples - -Group by and perform an aggregation -```shell -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr to-df - | dfr group-by a - | dfr aggregate [ - ("b" | dfr min | dfr as "b_min") - ("b" | dfr max | dfr as "b_max") - ("b" | dfr sum | dfr as "b_sum") - ] -``` - -Group by and perform an aggregation -```shell -> [[a b]; [1 2] [1 4] [2 6] [2 4]] - | dfr to-df - | dfr to-lazy - | dfr group-by a - | dfr aggregate [ - ("b" | dfr min | dfr as "b_min") - ("b" | dfr max | dfr as "b_max") - ("b" | dfr sum | dfr as "b_sum") - ] - | dfr collect -``` diff --git a/book/commands/dfr_as-nu.md b/book/commands/dfr_as-nu.md deleted file mode 100644 index 7899b3bd7b0..00000000000 --- a/book/commands/dfr_as-nu.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr as-nu -version: 0.63.1 -usage: | - Convert expression to a nu value for access and exploration ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr as-nu ``` - -## Examples - -Convert a col expression into a nushell value -```shell -> dfr col col_a | dfr as-nu -``` diff --git a/book/commands/dfr_count-unique.md b/book/commands/dfr_count-unique.md deleted file mode 100644 index 315349e7066..00000000000 --- a/book/commands/dfr_count-unique.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: dfr count-unique -version: 0.63.0 -usage: | - Counts unique values or creates a n-unique expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr count-unique ``` - -## Examples - -Counts unique values -```shell -> [1 1 2 2 3 3 4] | dfr to-df | dfr count-unique -``` - -Creates a is n-unique expression from a column -```shell -> dfr col a | dfr n-unique -``` diff --git a/book/commands/dfr_flatten.md b/book/commands/dfr_flatten.md deleted file mode 100644 index b4039b947fa..00000000000 --- a/book/commands/dfr_flatten.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr flatten -version: 0.63.0 -usage: | - creates a flatten expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr flatten ``` - -## Examples - - -```shell -> -``` diff --git a/book/commands/dfr_is-not-null.md b/book/commands/dfr_is-not-null.md deleted file mode 100644 index f795d9146b8..00000000000 --- a/book/commands/dfr_is-not-null.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: dfr is-not-null -version: 0.63.0 -usage: | - Creates mask where value is not null or creates a is-not-null expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr is-not-null ``` - -## Examples - -Create mask where values are not null -```shell -> let s = ([5 6 0 8] | dfr to-df); - let res = ($s / $s); - $res | dfr is-not-null -``` - -Creates a is not null expression from a column -```shell -> dfr col a | dfr is-not-null -``` diff --git a/book/commands/dfr_is-null.md b/book/commands/dfr_is-null.md deleted file mode 100644 index 96c8c554cb0..00000000000 --- a/book/commands/dfr_is-null.md +++ /dev/null @@ -1,33 +0,0 @@ ---- -title: dfr is-null -version: 0.63.0 -usage: | - Creates mask where value is null or creates a is-null expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr is-null ``` - -## Examples - -Create mask where values are null -```shell -> let s = ([5 6 0 8] | dfr to-df); - let res = ($s / $s); - $res | dfr is-null -``` - -Creates a is not null expression from a column -```shell -> dfr col a | dfr is-null -``` diff --git a/book/commands/dfr_max.md b/book/commands/dfr_max.md deleted file mode 100644 index 59ea5ebb1c8..00000000000 --- a/book/commands/dfr_max.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr max -version: 0.63.0 -usage: | - Aggregates columns to their max value or creates a max expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr max ``` - -## Examples - - -```shell -> -``` diff --git a/book/commands/dfr_mean.md b/book/commands/dfr_mean.md deleted file mode 100644 index 1d11ea05aa9..00000000000 --- a/book/commands/dfr_mean.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr mean -version: 0.63.0 -usage: | - Aggregates columns to their mean value or creates a mean expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr mean ``` - -## Examples - - -```shell -> -``` diff --git a/book/commands/dfr_median.md b/book/commands/dfr_median.md deleted file mode 100644 index 6a4c12d9739..00000000000 --- a/book/commands/dfr_median.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr median -version: 0.63.0 -usage: | - Aggregates columns to their median value or creates a median expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr median ``` - -## Examples - - -```shell -> -``` diff --git a/book/commands/dfr_min.md b/book/commands/dfr_min.md deleted file mode 100644 index da9596e3c93..00000000000 --- a/book/commands/dfr_min.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr min -version: 0.63.0 -usage: | - Aggregates columns to their min value or creates a min expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr min ``` - -## Examples - - -```shell -> -``` diff --git a/book/commands/dfr_n-unique.md b/book/commands/dfr_n-unique.md deleted file mode 100644 index 2aee52cacfe..00000000000 --- a/book/commands/dfr_n-unique.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: dfr n-unique -version: 0.63.1 -usage: | - Counts unique values or creates a n-unique expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr n-unique ``` - -## Examples - -Counts unique values -```shell -> [1 1 2 2 3 3 4] | dfr to-df | dfr n-unique -``` - -Creates a is n-unique expression from a column -```shell -> dfr col a | dfr n-unique -``` diff --git a/book/commands/dfr_not.md b/book/commands/dfr_not.md deleted file mode 100644 index 966eb0a1c78..00000000000 --- a/book/commands/dfr_not.md +++ /dev/null @@ -1,31 +0,0 @@ ---- -title: dfr not -version: 0.63.0 -usage: | - Inverts boolean mask or creates a not expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr not ``` - -## Examples - -Inverts boolean mask -```shell -> [true false true] | dfr to-df | dfr not -``` - -Creates a not expression from a column -```shell -> dfr col a | dfr not -``` diff --git a/book/commands/dfr_rename.md b/book/commands/dfr_rename.md deleted file mode 100644 index 1a33e3fe26f..00000000000 --- a/book/commands/dfr_rename.md +++ /dev/null @@ -1,30 +0,0 @@ ---- -title: dfr rename -version: 0.63.0 -usage: | - Renames a series ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr rename (name)``` - -## Parameters - - - `name`: new series name - -## Examples - -Renames a series -```shell -> [5 6 7 8] | dfr to-df | dfr rename new_name -``` diff --git a/book/commands/dfr_sort.md b/book/commands/dfr_sort.md deleted file mode 100644 index e237e404048..00000000000 --- a/book/commands/dfr_sort.md +++ /dev/null @@ -1,36 +0,0 @@ ---- -title: dfr sort -version: 0.63.0 -usage: | - Creates new sorted dataframe or series ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr sort ...rest --reverse``` - -## Parameters - - - `...rest`: column names to sort dataframe - - `--reverse`: invert sort - -## Examples - -Create new sorted dataframe -```shell -> [[a b]; [3 4] [1 2]] | dfr to-df | dfr sort a -``` - -Create new sorted series -```shell -> [3 4 1 2] | dfr to-df | dfr sort -``` diff --git a/book/commands/dfr_sum.md b/book/commands/dfr_sum.md deleted file mode 100644 index 23aa26a39a1..00000000000 --- a/book/commands/dfr_sum.md +++ /dev/null @@ -1,26 +0,0 @@ ---- -title: dfr sum -version: 0.63.0 -usage: | - Aggregates columns to their sum value or creates a sum expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr sum ``` - -## Examples - - -```shell -> -``` diff --git a/book/commands/dfr_when.md b/book/commands/dfr_when.md deleted file mode 100644 index c17f7a9832d..00000000000 --- a/book/commands/dfr_when.md +++ /dev/null @@ -1,38 +0,0 @@ ---- -title: dfr when -version: 0.63.0 -usage: | - Creates a when expression ---- - - - -# {{ frontmatter.title }} - -
{{ frontmatter.usage }}
- -## Signature - -```> dfr when (when predicate) --then --otherwise``` - -## Parameters - - - `when predicate`: Name of column to be used - - `--then {any}`: Expression that will be applied when predicate is true - - `--otherwise {any}`: Expression that will be applied when predicate is false - -## Examples - -Create a new column for the dataframe -```shell -> [[a b]; [1 2] [3 4]] - | dfr to-df - | dfr to-lazy - | dfr with-column ( - dfr when ((dfr col a) > 2) --then 4 --otherwise 5 | dfr as "c" - ) - | dfr collect -``` diff --git a/book/commands/do.md b/book/commands/do.md index dc4a25d9b1a..6b24a8945af 100644 --- a/book/commands/do.md +++ b/book/commands/do.md @@ -1,6 +1,6 @@ --- title: do -version: 0.63.0 +version: 0.64.0 usage: | Run a block --- diff --git a/book/commands/drop.md b/book/commands/drop.md index b97f96cdfef..88dbd5f0fa1 100644 --- a/book/commands/drop.md +++ b/book/commands/drop.md @@ -1,6 +1,6 @@ --- title: drop -version: 0.63.0 +version: 0.64.0 usage: | Remove the last number of rows or columns. --- diff --git a/book/commands/drop_column.md b/book/commands/drop_column.md index 634ba0deb06..b8954fa1dda 100644 --- a/book/commands/drop_column.md +++ b/book/commands/drop_column.md @@ -1,6 +1,6 @@ --- title: drop column -version: 0.63.0 +version: 0.64.0 usage: | Remove the last number of columns. If you want to remove columns by name, try 'reject'. --- diff --git a/book/commands/drop_nth.md b/book/commands/drop_nth.md index 6cb113d3d65..4571c9914d2 100644 --- a/book/commands/drop_nth.md +++ b/book/commands/drop_nth.md @@ -1,6 +1,6 @@ --- title: drop nth -version: 0.63.0 +version: 0.64.0 usage: | Drop the selected rows. --- @@ -49,3 +49,13 @@ Drop range rows from second to fourth ```shell > echo [first second third fourth fifth] | drop nth (1..3) ``` + +Drop all rows except first row +```shell +> [0,1,2,3,4,5] | drop nth 1.. +``` + +Drop rows 3,4,5 +```shell +> [0,1,2,3,4,5] | drop nth 3.. +``` diff --git a/book/commands/du.md b/book/commands/du.md index a546bf0f916..31f9bb53f40 100644 --- a/book/commands/du.md +++ b/book/commands/du.md @@ -1,6 +1,6 @@ --- title: du -version: 0.63.0 +version: 0.64.0 usage: | Find disk usage sizes of specified items. --- diff --git a/book/commands/each.md b/book/commands/each.md index bf7b6bff18e..a64bd24ee34 100644 --- a/book/commands/each.md +++ b/book/commands/each.md @@ -1,6 +1,6 @@ --- title: each -version: 0.63.0 +version: 0.64.0 usage: | Run a block on each element of input --- diff --git a/book/commands/each_while.md b/book/commands/each_while.md new file mode 100644 index 00000000000..2100510bc71 --- /dev/null +++ b/book/commands/each_while.md @@ -0,0 +1,36 @@ +--- +title: each while +version: 0.64.0 +usage: | + Run a block on each element of input until a $nothing is found +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> each while (block) --numbered``` + +## Parameters + + - `block`: the block to run + - `--numbered`: iterate with an index + +## Examples + +Multiplies elements in list +```shell +> [1 2 3] | each while { |it| if $it < 3 {$it} else {$nothing} } +``` + +Iterate over each element, print the matching value and its index +```shell +> [1 2 3] | each while -n { |it| if $it.item < 2 { $"value ($it.item) at ($it.index)!"} else { $nothing } } +``` diff --git a/book/commands/echo.md b/book/commands/echo.md index 7acc5264058..8bdd39e8b56 100644 --- a/book/commands/echo.md +++ b/book/commands/echo.md @@ -1,6 +1,6 @@ --- title: echo -version: 0.63.0 +version: 0.64.0 usage: | Echo the arguments back to the user. --- diff --git a/book/commands/empty.md b/book/commands/empty.md index 43d8c4a2093..3d6ca6fe4ce 100644 --- a/book/commands/empty.md +++ b/book/commands/empty.md @@ -1,6 +1,6 @@ --- title: empty? -version: 0.63.0 +version: 0.64.0 usage: | Check for empty values. --- diff --git a/book/commands/enter.md b/book/commands/enter.md index ffd16bf6a06..3a7a41c8535 100644 --- a/book/commands/enter.md +++ b/book/commands/enter.md @@ -1,6 +1,6 @@ --- title: enter -version: 0.63.0 +version: 0.64.0 usage: | Enters a new shell at the given path. --- diff --git a/book/commands/env.md b/book/commands/env.md index c2c973d8348..49c26405678 100644 --- a/book/commands/env.md +++ b/book/commands/env.md @@ -1,6 +1,6 @@ --- title: env -version: 0.63.0 +version: 0.64.0 usage: | Display current environment variables --- diff --git a/book/commands/error_make.md b/book/commands/error_make.md index d4347c93366..a8c5cf3088e 100644 --- a/book/commands/error_make.md +++ b/book/commands/error_make.md @@ -1,6 +1,6 @@ --- title: error make -version: 0.63.0 +version: 0.64.0 usage: | Create an error. --- diff --git a/book/commands/every.md b/book/commands/every.md index 242b2d12c76..05ea6fc1b20 100644 --- a/book/commands/every.md +++ b/book/commands/every.md @@ -1,6 +1,6 @@ --- title: every -version: 0.63.0 +version: 0.64.0 usage: | Show (or skip) every n-th row, starting from the first one. --- diff --git a/book/commands/exec.md b/book/commands/exec.md index cbe24e175a8..7d1bd221239 100644 --- a/book/commands/exec.md +++ b/book/commands/exec.md @@ -1,6 +1,6 @@ --- title: exec -version: 0.63.0 +version: 0.64.0 usage: | Execute a command, replacing the current process. --- diff --git a/book/commands/exit.md b/book/commands/exit.md index 15398ec96f6..8f456beaac2 100644 --- a/book/commands/exit.md +++ b/book/commands/exit.md @@ -1,6 +1,6 @@ --- title: exit -version: 0.63.0 +version: 0.64.0 usage: | Exit a Nu shell or exit Nu entirely. --- diff --git a/book/commands/dfr_explode.md b/book/commands/explode.md similarity index 86% rename from book/commands/dfr_explode.md rename to book/commands/explode.md index 478e4166a32..0127fa758c8 100644 --- a/book/commands/dfr_explode.md +++ b/book/commands/explode.md @@ -1,6 +1,6 @@ --- -title: dfr explode -version: 0.63.0 +title: explode +version: 0.64.0 usage: | creates an explode expression --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr explode ``` +```> explode ``` ## Examples diff --git a/book/commands/export.md b/book/commands/export.md index aa92a9a384f..ebe416fe5e7 100644 --- a/book/commands/export.md +++ b/book/commands/export.md @@ -1,6 +1,6 @@ --- title: export -version: 0.63.0 +version: 0.64.0 usage: | Export custom commands or environment variables from a module. --- @@ -20,8 +20,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/export_alias.md b/book/commands/export_alias.md index 5975b23ccf4..4ca9c48ca95 100644 --- a/book/commands/export_alias.md +++ b/book/commands/export_alias.md @@ -1,6 +1,6 @@ --- title: export alias -version: 0.63.0 +version: 0.64.0 usage: | Define an alias and export it from a module --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/export_def-env.md b/book/commands/export_def-env.md index 83988f0ef4a..4bd6ebcdbfc 100644 --- a/book/commands/export_def-env.md +++ b/book/commands/export_def-env.md @@ -1,6 +1,6 @@ --- title: export def-env -version: 0.63.0 +version: 0.64.0 usage: | Define a custom command that participates in the environment and export it from a module --- @@ -26,8 +26,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/export_def.md b/book/commands/export_def.md index b2e94d1cf5e..fcbc640a500 100644 --- a/book/commands/export_def.md +++ b/book/commands/export_def.md @@ -1,6 +1,6 @@ --- title: export def -version: 0.63.0 +version: 0.64.0 usage: | Define a custom command and export it from a module --- @@ -26,8 +26,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/export_env.md b/book/commands/export_env.md index d63be6f30ab..f2ace453fce 100644 --- a/book/commands/export_env.md +++ b/book/commands/export_env.md @@ -1,6 +1,6 @@ --- title: export env -version: 0.63.0 +version: 0.64.0 usage: | Export a block from a module that will be evaluated as an environment variable when imported. --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/export_extern.md b/book/commands/export_extern.md index b28f3f5f13f..85cffa91964 100644 --- a/book/commands/export_extern.md +++ b/book/commands/export_extern.md @@ -1,6 +1,6 @@ --- title: export extern -version: 0.63.0 +version: 0.64.0 usage: | Define an extern and export it from a module --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/expr-not.md b/book/commands/expr-not.md new file mode 100644 index 00000000000..577309276d9 --- /dev/null +++ b/book/commands/expr-not.md @@ -0,0 +1,26 @@ +--- +title: expr-not +version: 0.64.0 +usage: | + creates a not expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> expr-not ``` + +## Examples + +Creates a not expression +```shell +> (col a) > 2) | expr-not +``` diff --git a/book/commands/extern.md b/book/commands/extern.md index 7c72cd46537..c69eb683a38 100644 --- a/book/commands/extern.md +++ b/book/commands/extern.md @@ -1,6 +1,6 @@ --- title: extern -version: 0.63.0 +version: 0.64.0 usage: | Define a signature for an external command --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/fetch.md b/book/commands/fetch.md index ca7308930f8..1241d9df47f 100644 --- a/book/commands/fetch.md +++ b/book/commands/fetch.md @@ -1,6 +1,6 @@ --- title: fetch -version: 0.63.0 +version: 0.64.0 usage: | Fetch the contents from a URL. --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> fetch (URL) --user --password --timeout --headers --raw``` +```> fetch (URL) --user --password --timeout --headers --raw --output --bin --append``` ## Parameters @@ -26,6 +26,9 @@ usage: | - `--timeout {int}`: timeout period in seconds - `--headers {any}`: custom headers you want to add - `--raw`: fetch contents as text rather than a table + - `--output {path}`: save contents into a file + - `--bin`: if saving into a file, save as raw binary + - `--append`: if saving into a file, append to end of file ## Notes ```text diff --git a/book/commands/find.md b/book/commands/find.md index 84b1cd6d8c3..8a99b89fce8 100644 --- a/book/commands/find.md +++ b/book/commands/find.md @@ -1,6 +1,6 @@ --- title: find -version: 0.63.0 +version: 0.64.0 usage: | Searches terms in the input or for elements of the input that satisfies the predicate. --- diff --git a/book/commands/first.md b/book/commands/first.md index 03b09f6f0fb..095484aca9f 100644 --- a/book/commands/first.md +++ b/book/commands/first.md @@ -1,6 +1,6 @@ --- title: first -version: 0.63.0 +version: 0.64.0 usage: | Show only the first number of rows. --- diff --git a/book/commands/flatten.md b/book/commands/flatten.md index f173e28d727..3db553e7094 100644 --- a/book/commands/flatten.md +++ b/book/commands/flatten.md @@ -1,6 +1,6 @@ --- title: flatten -version: 0.63.0 +version: 0.64.0 usage: | Flatten the table. --- diff --git a/book/commands/fmt.md b/book/commands/fmt.md index 37269879a4e..5bb26e6c5c8 100644 --- a/book/commands/fmt.md +++ b/book/commands/fmt.md @@ -1,6 +1,6 @@ --- title: fmt -version: 0.63.0 +version: 0.64.0 usage: | Format a number --- diff --git a/book/commands/for.md b/book/commands/for.md index e57ea0674cf..2379ca2d489 100644 --- a/book/commands/for.md +++ b/book/commands/for.md @@ -1,6 +1,6 @@ --- title: for -version: 0.63.0 +version: 0.64.0 usage: | Loop over a range --- @@ -27,8 +27,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/format.md b/book/commands/format.md index 16ddaa57532..4fd88343c48 100644 --- a/book/commands/format.md +++ b/book/commands/format.md @@ -1,6 +1,6 @@ --- title: format -version: 0.63.0 +version: 0.64.0 usage: | Format columns into a string using a simple pattern. --- diff --git a/book/commands/format_filesize.md b/book/commands/format_filesize.md index d2ff6d42482..35e74b6d713 100644 --- a/book/commands/format_filesize.md +++ b/book/commands/format_filesize.md @@ -1,6 +1,6 @@ --- title: format filesize -version: 0.63.0 +version: 0.64.0 usage: | Converts a column of filesizes to some specified format --- diff --git a/book/commands/from.md b/book/commands/from.md index 1d222c8e162..2ec1d441a1d 100644 --- a/book/commands/from.md +++ b/book/commands/from.md @@ -1,6 +1,6 @@ --- title: from -version: 0.63.0 +version: 0.64.0 usage: | Parse a string or binary data into structured data --- diff --git a/book/commands/from_csv.md b/book/commands/from_csv.md index 2680d20bcce..be12487fb3a 100644 --- a/book/commands/from_csv.md +++ b/book/commands/from_csv.md @@ -1,6 +1,6 @@ --- title: from csv -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .csv and create table. --- diff --git a/book/commands/from_eml.md b/book/commands/from_eml.md index 5ef097f945e..0658c50c509 100644 --- a/book/commands/from_eml.md +++ b/book/commands/from_eml.md @@ -1,6 +1,6 @@ --- title: from eml -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .eml and create table. --- diff --git a/book/commands/from_ics.md b/book/commands/from_ics.md index d5249ba1b61..306351b7705 100644 --- a/book/commands/from_ics.md +++ b/book/commands/from_ics.md @@ -1,6 +1,6 @@ --- title: from ics -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .ics and create table. --- diff --git a/book/commands/from_ini.md b/book/commands/from_ini.md index ff615744c9c..ddac540aa70 100644 --- a/book/commands/from_ini.md +++ b/book/commands/from_ini.md @@ -1,6 +1,6 @@ --- title: from ini -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .ini and create table --- diff --git a/book/commands/from_json.md b/book/commands/from_json.md index 4d1cdbd09a9..816d20db81e 100644 --- a/book/commands/from_json.md +++ b/book/commands/from_json.md @@ -1,6 +1,6 @@ --- title: from json -version: 0.63.0 +version: 0.64.0 usage: | Convert from json to structured data --- diff --git a/book/commands/from_nuon.md b/book/commands/from_nuon.md index 9131a7323b0..38d3335e293 100644 --- a/book/commands/from_nuon.md +++ b/book/commands/from_nuon.md @@ -1,6 +1,6 @@ --- title: from nuon -version: 0.63.0 +version: 0.64.0 usage: | Convert from nuon to structured data --- diff --git a/book/commands/from_ods.md b/book/commands/from_ods.md index b6aef018467..ab8e399a2e4 100644 --- a/book/commands/from_ods.md +++ b/book/commands/from_ods.md @@ -1,6 +1,6 @@ --- title: from ods -version: 0.63.0 +version: 0.64.0 usage: | Parse OpenDocument Spreadsheet(.ods) data and create table. --- @@ -26,10 +26,10 @@ usage: | Convert binary .ods data to a table ```shell -> open test.txt | from ods +> open --raw test.ods | from ods ``` Convert binary .ods data to a table, specifying the tables ```shell -> open test.txt | from ods -s [Spreadsheet1] +> open --raw test.ods | from ods -s [Spreadsheet1] ``` diff --git a/book/commands/from_ssv.md b/book/commands/from_ssv.md index a456abd6a5f..88588b580e6 100644 --- a/book/commands/from_ssv.md +++ b/book/commands/from_ssv.md @@ -1,6 +1,6 @@ --- title: from ssv -version: 0.63.0 +version: 0.64.0 usage: | Parse text as space-separated values and create a table. The default minimum number of spaces counted as a separator is 2. --- diff --git a/book/commands/from_toml.md b/book/commands/from_toml.md index 1116e222313..daa7e16d136 100644 --- a/book/commands/from_toml.md +++ b/book/commands/from_toml.md @@ -1,6 +1,6 @@ --- title: from toml -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .toml and create table. --- diff --git a/book/commands/from_tsv.md b/book/commands/from_tsv.md index 4c5adcb5cf6..60123e5cdd7 100644 --- a/book/commands/from_tsv.md +++ b/book/commands/from_tsv.md @@ -1,6 +1,6 @@ --- title: from tsv -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .tsv and create table. --- diff --git a/book/commands/from_url.md b/book/commands/from_url.md index 0fde53eab28..b064527daf0 100644 --- a/book/commands/from_url.md +++ b/book/commands/from_url.md @@ -1,6 +1,6 @@ --- title: from url -version: 0.63.0 +version: 0.64.0 usage: | Parse url-encoded string as a table. --- diff --git a/book/commands/from_vcf.md b/book/commands/from_vcf.md index 444af4b657c..3c8bd449129 100644 --- a/book/commands/from_vcf.md +++ b/book/commands/from_vcf.md @@ -1,6 +1,6 @@ --- title: from vcf -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .vcf and create table. --- diff --git a/book/commands/from_xlsx.md b/book/commands/from_xlsx.md index d8a8a3ae478..3eba5cb60a6 100644 --- a/book/commands/from_xlsx.md +++ b/book/commands/from_xlsx.md @@ -1,6 +1,6 @@ --- title: from xlsx -version: 0.63.0 +version: 0.64.0 usage: | Parse binary Excel(.xlsx) data and create table. --- @@ -26,10 +26,10 @@ usage: | Convert binary .xlsx data to a table ```shell -> open test.txt | from xlsx +> open --raw test.xlsx | from xlsx ``` Convert binary .xlsx data to a table, specifying the tables ```shell -> open test.txt | from xlsx -s [Spreadsheet1] +> open --raw test.xlsx | from xlsx -s [Spreadsheet1] ``` diff --git a/book/commands/from_xml.md b/book/commands/from_xml.md index 983e47e01e4..958a4b42cba 100644 --- a/book/commands/from_xml.md +++ b/book/commands/from_xml.md @@ -1,6 +1,6 @@ --- title: from xml -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .xml and create table. --- diff --git a/book/commands/from_yaml.md b/book/commands/from_yaml.md index 29c89007594..56acd50fc4a 100644 --- a/book/commands/from_yaml.md +++ b/book/commands/from_yaml.md @@ -1,6 +1,6 @@ --- title: from yaml -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .yaml/.yml and create table. --- diff --git a/book/commands/from_yml.md b/book/commands/from_yml.md index c7d92a8abee..dcbbdab0be8 100644 --- a/book/commands/from_yml.md +++ b/book/commands/from_yml.md @@ -1,6 +1,6 @@ --- title: from yml -version: 0.63.0 +version: 0.64.0 usage: | Parse text as .yaml/.yml and create table. --- diff --git a/book/commands/g.md b/book/commands/g.md index 69a44c8916f..568b1ee23be 100644 --- a/book/commands/g.md +++ b/book/commands/g.md @@ -1,6 +1,6 @@ --- title: g -version: 0.63.0 +version: 0.64.0 usage: | Switch to a given shell. --- diff --git a/book/commands/get.md b/book/commands/get.md index 6fd01941e7d..2d64f215237 100644 --- a/book/commands/get.md +++ b/book/commands/get.md @@ -1,6 +1,6 @@ --- title: get -version: 0.63.0 +version: 0.64.0 usage: | Extract data using a cell path. --- @@ -16,13 +16,14 @@ usage: | ## Signature -```> get (cell_path) ...rest --ignore-errors``` +```> get (cell_path) ...rest --ignore-errors --sensitive``` ## Parameters - `cell_path`: the cell path to the data - `...rest`: additional cell paths - `--ignore-errors`: return nothing if path can't be found + - `--sensitive`: get path in a case sensitive manner ## Examples @@ -45,3 +46,13 @@ Extract the cpu list from the sys information record ```shell > sys | get cpu ``` + +Getting Path/PATH in a case insensitive way +```shell +> $env | get paTH +``` + +Getting Path in a case sensitive way, won't work for 'PATH' +```shell +> $env | get -s Path +``` diff --git a/book/commands/glob.md b/book/commands/glob.md index f295610873b..30ddbd438d4 100644 --- a/book/commands/glob.md +++ b/book/commands/glob.md @@ -1,6 +1,6 @@ --- title: glob -version: 0.63.0 +version: 0.64.0 usage: | Creates a list of files and/or folders based on the glob pattern provided. --- diff --git a/book/commands/grid.md b/book/commands/grid.md index ea369a015d7..3fef3831b6d 100644 --- a/book/commands/grid.md +++ b/book/commands/grid.md @@ -1,6 +1,6 @@ --- title: grid -version: 0.63.0 +version: 0.64.0 usage: | Renders the output to a textual terminal grid. --- diff --git a/book/commands/group-by.md b/book/commands/group-by.md index cd5b53d5e3f..9327eed453c 100644 --- a/book/commands/group-by.md +++ b/book/commands/group-by.md @@ -1,6 +1,6 @@ --- title: group-by -version: 0.63.0 +version: 0.64.0 usage: | Create a new table grouped. --- diff --git a/book/commands/group.md b/book/commands/group.md index 5f1b43eed58..c462227002d 100644 --- a/book/commands/group.md +++ b/book/commands/group.md @@ -1,6 +1,6 @@ --- title: group -version: 0.63.0 +version: 0.64.0 usage: | Groups input into groups of `group_size`. --- diff --git a/book/commands/gstat.md b/book/commands/gstat.md index bb7c04131ee..e31f15a21a9 100644 --- a/book/commands/gstat.md +++ b/book/commands/gstat.md @@ -1,6 +1,6 @@ --- title: gstat -version: 0.63.0 +version: 0.64.0 usage: | Get the git status of a repo --- diff --git a/book/commands/hash.md b/book/commands/hash.md index 7bb584a6f24..fafb9a99c08 100644 --- a/book/commands/hash.md +++ b/book/commands/hash.md @@ -1,6 +1,6 @@ --- title: hash -version: 0.63.0 +version: 0.64.0 usage: | Apply hash function. --- diff --git a/book/commands/hash_base64.md b/book/commands/hash_base64.md index 0646e8b4e59..eff49616a15 100644 --- a/book/commands/hash_base64.md +++ b/book/commands/hash_base64.md @@ -1,6 +1,6 @@ --- title: hash base64 -version: 0.63.0 +version: 0.64.0 usage: | base64 encode or decode a value --- diff --git a/book/commands/hash_md5.md b/book/commands/hash_md5.md index 3be37340420..f0cc5e8ec49 100644 --- a/book/commands/hash_md5.md +++ b/book/commands/hash_md5.md @@ -1,6 +1,6 @@ --- title: hash md5 -version: 0.63.0 +version: 0.64.0 usage: | Hash a value using the md5 hash algorithm --- diff --git a/book/commands/hash_sha256.md b/book/commands/hash_sha256.md index afffa434957..3003baacddf 100644 --- a/book/commands/hash_sha256.md +++ b/book/commands/hash_sha256.md @@ -1,6 +1,6 @@ --- title: hash sha256 -version: 0.63.0 +version: 0.64.0 usage: | Hash a value using the sha256 hash algorithm --- diff --git a/book/commands/headers.md b/book/commands/headers.md index 6da4b526ea2..4553a7d7475 100644 --- a/book/commands/headers.md +++ b/book/commands/headers.md @@ -1,6 +1,6 @@ --- title: headers -version: 0.63.0 +version: 0.64.0 usage: | Use the first row of the table as column names. --- diff --git a/book/commands/help.md b/book/commands/help.md index 7f45bca6db6..2113d5c2340 100644 --- a/book/commands/help.md +++ b/book/commands/help.md @@ -1,6 +1,6 @@ --- title: help -version: 0.63.0 +version: 0.64.0 usage: | Display help information about commands. --- diff --git a/book/commands/hide.md b/book/commands/hide.md index 769f8557728..8c132d350ca 100644 --- a/book/commands/hide.md +++ b/book/commands/hide.md @@ -1,6 +1,6 @@ --- title: hide -version: 0.63.0 +version: 0.64.0 usage: | Hide symbols in the current scope --- @@ -26,9 +26,8 @@ usage: | ```text Symbols are hidden by priority: First aliases, then custom commands, then environment variables. -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages - +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/histogram.md b/book/commands/histogram.md index 7a2c0d3c822..0e5aae2cdd1 100644 --- a/book/commands/histogram.md +++ b/book/commands/histogram.md @@ -1,6 +1,6 @@ --- title: histogram -version: 0.63.0 +version: 0.64.0 usage: | Creates a new table with a histogram based on the column name passed in. --- diff --git a/book/commands/history.md b/book/commands/history.md index 6c0e63d42ce..4d311da3988 100644 --- a/book/commands/history.md +++ b/book/commands/history.md @@ -1,6 +1,6 @@ --- title: history -version: 0.63.0 +version: 0.64.0 usage: | Get the command history --- diff --git a/book/commands/if.md b/book/commands/if.md index 89799a505ec..ed30f725732 100644 --- a/book/commands/if.md +++ b/book/commands/if.md @@ -1,6 +1,6 @@ --- title: if -version: 0.63.0 +version: 0.64.0 usage: | Conditionally run a block. --- @@ -26,8 +26,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/ignore.md b/book/commands/ignore.md index 237003bd67f..431e4e84714 100644 --- a/book/commands/ignore.md +++ b/book/commands/ignore.md @@ -1,6 +1,6 @@ --- title: ignore -version: 0.63.0 +version: 0.64.0 usage: | Ignore the output of the previous command in the pipeline --- diff --git a/book/commands/inc.md b/book/commands/inc.md index a0cf8ce1e7e..a48625cedcf 100644 --- a/book/commands/inc.md +++ b/book/commands/inc.md @@ -1,6 +1,6 @@ --- title: inc -version: 0.63.0 +version: 0.64.0 usage: | Increment a value or version. Optionally use the column of a table. --- diff --git a/book/commands/input.md b/book/commands/input.md index a09407a87f9..f822fc21e15 100644 --- a/book/commands/input.md +++ b/book/commands/input.md @@ -1,6 +1,6 @@ --- title: input -version: 0.63.0 +version: 0.64.0 usage: | Get input from the user. --- diff --git a/book/commands/insert.md b/book/commands/insert.md index 87fbdd13391..5d325e719a5 100644 --- a/book/commands/insert.md +++ b/book/commands/insert.md @@ -1,6 +1,6 @@ --- title: insert -version: 0.63.0 +version: 0.64.0 usage: | Insert a new column. --- diff --git a/book/commands/into.md b/book/commands/into.md index f9a0d958b13..ce61b12b8b1 100644 --- a/book/commands/into.md +++ b/book/commands/into.md @@ -1,6 +1,6 @@ --- title: into -version: 0.63.0 +version: 0.64.0 usage: | Commands to convert data from one type to another. --- diff --git a/book/commands/into_binary.md b/book/commands/into_binary.md index aa3fda5e05b..6b99d9f00e6 100644 --- a/book/commands/into_binary.md +++ b/book/commands/into_binary.md @@ -1,6 +1,6 @@ --- title: into binary -version: 0.63.0 +version: 0.64.0 usage: | Convert value to a binary primitive --- diff --git a/book/commands/into_bool.md b/book/commands/into_bool.md index 44dd4c048a5..62141563a14 100644 --- a/book/commands/into_bool.md +++ b/book/commands/into_bool.md @@ -1,6 +1,6 @@ --- title: into bool -version: 0.63.0 +version: 0.64.0 usage: | Convert value to boolean --- diff --git a/book/commands/into_datetime.md b/book/commands/into_datetime.md index 0570ec4be1c..21ffb86b800 100644 --- a/book/commands/into_datetime.md +++ b/book/commands/into_datetime.md @@ -1,6 +1,6 @@ --- title: into datetime -version: 0.63.0 +version: 0.64.0 usage: | Convert text into a datetime --- diff --git a/book/commands/into_decimal.md b/book/commands/into_decimal.md index 7a9295133d0..c2f1fe23c5a 100644 --- a/book/commands/into_decimal.md +++ b/book/commands/into_decimal.md @@ -1,6 +1,6 @@ --- title: into decimal -version: 0.63.0 +version: 0.64.0 usage: | Convert text into a decimal --- diff --git a/book/commands/into_duration.md b/book/commands/into_duration.md index 0ddf31927cf..ebd0293c7d5 100644 --- a/book/commands/into_duration.md +++ b/book/commands/into_duration.md @@ -1,6 +1,6 @@ --- title: into duration -version: 0.63.0 +version: 0.64.0 usage: | Convert value to duration --- diff --git a/book/commands/into_filesize.md b/book/commands/into_filesize.md index 8cfab311765..4c3a383c536 100644 --- a/book/commands/into_filesize.md +++ b/book/commands/into_filesize.md @@ -1,6 +1,6 @@ --- title: into filesize -version: 0.63.0 +version: 0.64.0 usage: | Convert value to filesize --- diff --git a/book/commands/into_int.md b/book/commands/into_int.md index 1e19a33cc3b..74b690dc1a0 100644 --- a/book/commands/into_int.md +++ b/book/commands/into_int.md @@ -1,6 +1,6 @@ --- title: into int -version: 0.63.0 +version: 0.64.0 usage: | Convert value to integer --- diff --git a/book/commands/into_string.md b/book/commands/into_string.md index 82b76b9aaa6..6c1d00582a2 100644 --- a/book/commands/into_string.md +++ b/book/commands/into_string.md @@ -1,6 +1,6 @@ --- title: into string -version: 0.63.0 +version: 0.64.0 usage: | Convert value to string --- diff --git a/book/commands/is-admin.md b/book/commands/is-admin.md new file mode 100644 index 00000000000..f461fb29770 --- /dev/null +++ b/book/commands/is-admin.md @@ -0,0 +1,26 @@ +--- +title: is-admin +version: 0.64.0 +usage: | + Check if nushell is running with administrator or root privileges +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> is-admin ``` + +## Examples + +Echo 'iamroot' if nushell is running with admin/root privileges, and 'iamnotroot' if not. +```shell +> if is-admin { echo "iamroot" } else { echo "iamnotroot" } +``` diff --git a/book/commands/is-not-null.md b/book/commands/is-not-null.md new file mode 100644 index 00000000000..9a512f260ff --- /dev/null +++ b/book/commands/is-not-null.md @@ -0,0 +1,26 @@ +--- +title: is-not-null +version: 0.64.0 +usage: | + creates a is not null expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> is-not-null ``` + +## Examples + +Creates a is not null expression from a column +```shell +> col a | is-not-null +``` diff --git a/book/commands/is-null.md b/book/commands/is-null.md new file mode 100644 index 00000000000..1c799b5f282 --- /dev/null +++ b/book/commands/is-null.md @@ -0,0 +1,26 @@ +--- +title: is-null +version: 0.64.0 +usage: | + creates a is null expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> is-null ``` + +## Examples + +Creates a is null expression from a column +```shell +> col a | is-null +``` diff --git a/book/commands/keep.md b/book/commands/keep.md index 12fb53fb207..f4c1e4fa264 100644 --- a/book/commands/keep.md +++ b/book/commands/keep.md @@ -1,6 +1,6 @@ --- title: keep -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/keep_until.md b/book/commands/keep_until.md index 56002f513a2..8333854f88f 100644 --- a/book/commands/keep_until.md +++ b/book/commands/keep_until.md @@ -1,6 +1,6 @@ --- title: keep until -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/keep_while.md b/book/commands/keep_while.md index 96b43700090..cb00abcdca5 100644 --- a/book/commands/keep_while.md +++ b/book/commands/keep_while.md @@ -1,6 +1,6 @@ --- title: keep while -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/keybindings.md b/book/commands/keybindings.md index ca17ecfb57b..02b6c6755ab 100644 --- a/book/commands/keybindings.md +++ b/book/commands/keybindings.md @@ -1,6 +1,6 @@ --- title: keybindings -version: 0.63.0 +version: 0.64.0 usage: | Keybindings related commands --- diff --git a/book/commands/keybindings_default.md b/book/commands/keybindings_default.md index a835bed507c..59543e66b1c 100644 --- a/book/commands/keybindings_default.md +++ b/book/commands/keybindings_default.md @@ -1,6 +1,6 @@ --- title: keybindings default -version: 0.63.0 +version: 0.64.0 usage: | List default keybindings --- diff --git a/book/commands/keybindings_list.md b/book/commands/keybindings_list.md index c28aebbcc7e..7e3ff9e868f 100644 --- a/book/commands/keybindings_list.md +++ b/book/commands/keybindings_list.md @@ -1,6 +1,6 @@ --- title: keybindings list -version: 0.63.0 +version: 0.64.0 usage: | List available options that can be used to create keybindings --- diff --git a/book/commands/keybindings_listen.md b/book/commands/keybindings_listen.md index a8ab51a1b0c..10ba037e8f2 100644 --- a/book/commands/keybindings_listen.md +++ b/book/commands/keybindings_listen.md @@ -1,6 +1,6 @@ --- title: keybindings listen -version: 0.63.0 +version: 0.64.0 usage: | Get input from the user. --- diff --git a/book/commands/kill.md b/book/commands/kill.md index 3254f83cb5f..313d9a072b4 100644 --- a/book/commands/kill.md +++ b/book/commands/kill.md @@ -1,6 +1,6 @@ --- title: kill -version: 0.63.0 +version: 0.64.0 usage: | Kill a process using the process id. --- diff --git a/book/commands/last.md b/book/commands/last.md index ac55ec15f30..0b3beb03d7e 100644 --- a/book/commands/last.md +++ b/book/commands/last.md @@ -1,6 +1,6 @@ --- title: last -version: 0.63.0 +version: 0.64.0 usage: | Show only the last number of rows. --- diff --git a/book/commands/length.md b/book/commands/length.md index 493912001da..6346a6bcb09 100644 --- a/book/commands/length.md +++ b/book/commands/length.md @@ -1,6 +1,6 @@ --- title: length -version: 0.63.0 +version: 0.64.0 usage: | Count the number of elements in the input. --- diff --git a/book/commands/let-env.md b/book/commands/let-env.md index 5883dfef6c2..29c20d405ae 100644 --- a/book/commands/let-env.md +++ b/book/commands/let-env.md @@ -1,6 +1,6 @@ --- title: let-env -version: 0.63.0 +version: 0.64.0 usage: | Create an environment variable and give it a value. --- diff --git a/book/commands/let.md b/book/commands/let.md index 030149981b4..21d87324e6e 100644 --- a/book/commands/let.md +++ b/book/commands/let.md @@ -1,6 +1,6 @@ --- title: let -version: 0.63.0 +version: 0.64.0 usage: | Create a variable and give it a value. --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/lines.md b/book/commands/lines.md index 5b0b786a6a2..525e5e549ba 100644 --- a/book/commands/lines.md +++ b/book/commands/lines.md @@ -1,6 +1,6 @@ --- title: lines -version: 0.63.0 +version: 0.64.0 usage: | Converts input to lines --- diff --git a/book/commands/dfr_list.md b/book/commands/list.md similarity index 88% rename from book/commands/dfr_list.md rename to book/commands/list.md index b14ad599d69..77a0481e3e2 100644 --- a/book/commands/dfr_list.md +++ b/book/commands/list.md @@ -1,6 +1,6 @@ --- -title: dfr list -version: 0.63.0 +title: list +version: 0.64.0 usage: | Aggregates a group to a Series --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr list ``` +```> list ``` ## Examples diff --git a/book/commands/dfr_lit.md b/book/commands/lit.md similarity index 85% rename from book/commands/dfr_lit.md rename to book/commands/lit.md index 4197f5d25a1..5abfadcc96f 100644 --- a/book/commands/dfr_lit.md +++ b/book/commands/lit.md @@ -1,6 +1,6 @@ --- -title: dfr lit -version: 0.63.0 +title: lit +version: 0.64.0 usage: | Creates a literal expression --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr lit (literal)``` +```> lit (literal)``` ## Parameters @@ -26,5 +26,5 @@ usage: | Created a literal expression and converts it to a nu object ```shell -> dfr lit 2 | dfr to-nu +> lit 2 | to-nu ``` diff --git a/book/commands/load-env.md b/book/commands/load-env.md index 85d68438a7b..f150aa39db4 100644 --- a/book/commands/load-env.md +++ b/book/commands/load-env.md @@ -1,6 +1,6 @@ --- title: load-env -version: 0.63.0 +version: 0.64.0 usage: | Loads an environment update from a record. --- diff --git a/book/commands/ls.md b/book/commands/ls.md index 07fea83c405..636afb19615 100644 --- a/book/commands/ls.md +++ b/book/commands/ls.md @@ -1,6 +1,6 @@ --- title: ls -version: 0.63.0 +version: 0.64.0 usage: | List the files in a directory. --- diff --git a/book/commands/match.md b/book/commands/match.md index c9684488bdc..fe8664b0b07 100644 --- a/book/commands/match.md +++ b/book/commands/match.md @@ -1,6 +1,6 @@ --- title: match -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/math.md b/book/commands/math.md index 290c4c124ca..35d20a465be 100644 --- a/book/commands/math.md +++ b/book/commands/math.md @@ -1,6 +1,6 @@ --- title: math -version: 0.63.0 +version: 0.64.0 usage: | Use mathematical functions as aggregate functions on a list of numbers or tables. --- diff --git a/book/commands/math_abs.md b/book/commands/math_abs.md index 5bd05988c09..54362292778 100644 --- a/book/commands/math_abs.md +++ b/book/commands/math_abs.md @@ -1,6 +1,6 @@ --- title: math abs -version: 0.63.0 +version: 0.64.0 usage: | Returns absolute values of a list of numbers --- diff --git a/book/commands/math_avg.md b/book/commands/math_avg.md index e80284bf11c..593cf511cdf 100644 --- a/book/commands/math_avg.md +++ b/book/commands/math_avg.md @@ -1,6 +1,6 @@ --- title: math avg -version: 0.63.0 +version: 0.64.0 usage: | Finds the average of a list of numbers or tables --- diff --git a/book/commands/math_ceil.md b/book/commands/math_ceil.md index b2ab27f17cf..96ee5b1aeaa 100644 --- a/book/commands/math_ceil.md +++ b/book/commands/math_ceil.md @@ -1,6 +1,6 @@ --- title: math ceil -version: 0.63.0 +version: 0.64.0 usage: | Applies the ceil function to a list of numbers --- diff --git a/book/commands/math_eval.md b/book/commands/math_eval.md index c7df77c2ef0..73d4384eac0 100644 --- a/book/commands/math_eval.md +++ b/book/commands/math_eval.md @@ -1,6 +1,6 @@ --- title: math eval -version: 0.63.0 +version: 0.64.0 usage: | Evaluate a math expression into a number --- diff --git a/book/commands/math_floor.md b/book/commands/math_floor.md index afefdc6ed0d..4b0309b1389 100644 --- a/book/commands/math_floor.md +++ b/book/commands/math_floor.md @@ -1,6 +1,6 @@ --- title: math floor -version: 0.63.0 +version: 0.64.0 usage: | Applies the floor function to a list of numbers --- diff --git a/book/commands/math_max.md b/book/commands/math_max.md index 5d288d924f6..bc1f2df63f7 100644 --- a/book/commands/math_max.md +++ b/book/commands/math_max.md @@ -1,6 +1,6 @@ --- title: math max -version: 0.63.0 +version: 0.64.0 usage: | Finds the maximum within a list of numbers or tables --- diff --git a/book/commands/math_median.md b/book/commands/math_median.md index 8e6f6da925f..2dd09bc1dcb 100644 --- a/book/commands/math_median.md +++ b/book/commands/math_median.md @@ -1,6 +1,6 @@ --- title: math median -version: 0.63.0 +version: 0.64.0 usage: | Gets the median of a list of numbers --- diff --git a/book/commands/math_min.md b/book/commands/math_min.md index 53b011feb86..0d575ecb58a 100644 --- a/book/commands/math_min.md +++ b/book/commands/math_min.md @@ -1,6 +1,6 @@ --- title: math min -version: 0.63.0 +version: 0.64.0 usage: | Finds the minimum within a list of numbers or tables --- diff --git a/book/commands/math_mode.md b/book/commands/math_mode.md index c628e2622d8..290f8b0feaa 100644 --- a/book/commands/math_mode.md +++ b/book/commands/math_mode.md @@ -1,6 +1,6 @@ --- title: math mode -version: 0.63.0 +version: 0.64.0 usage: | Gets the most frequent element(s) from a list of numbers or tables --- diff --git a/book/commands/math_product.md b/book/commands/math_product.md index 894de60bf3e..f9f02bb95eb 100644 --- a/book/commands/math_product.md +++ b/book/commands/math_product.md @@ -1,6 +1,6 @@ --- title: math product -version: 0.63.0 +version: 0.64.0 usage: | Finds the product of a list of numbers or tables --- diff --git a/book/commands/math_round.md b/book/commands/math_round.md index 906874cdf48..730d000b5f8 100644 --- a/book/commands/math_round.md +++ b/book/commands/math_round.md @@ -1,6 +1,6 @@ --- title: math round -version: 0.63.0 +version: 0.64.0 usage: | Applies the round function to a list of numbers --- diff --git a/book/commands/math_sqrt.md b/book/commands/math_sqrt.md index fc5d59ace6d..8355e8d0557 100644 --- a/book/commands/math_sqrt.md +++ b/book/commands/math_sqrt.md @@ -1,6 +1,6 @@ --- title: math sqrt -version: 0.63.0 +version: 0.64.0 usage: | Applies the square root function to a list of numbers --- diff --git a/book/commands/math_stddev.md b/book/commands/math_stddev.md index 87648909ca4..c0c5f112465 100644 --- a/book/commands/math_stddev.md +++ b/book/commands/math_stddev.md @@ -1,6 +1,6 @@ --- title: math stddev -version: 0.63.0 +version: 0.64.0 usage: | Finds the stddev of a list of numbers or tables --- diff --git a/book/commands/math_sum.md b/book/commands/math_sum.md index ec5ca394b4c..5c7ff424fa4 100644 --- a/book/commands/math_sum.md +++ b/book/commands/math_sum.md @@ -1,6 +1,6 @@ --- title: math sum -version: 0.63.0 +version: 0.64.0 usage: | Finds the sum of a list of numbers or tables --- diff --git a/book/commands/math_variance.md b/book/commands/math_variance.md index 33db4b9761d..9d9706c12bc 100644 --- a/book/commands/math_variance.md +++ b/book/commands/math_variance.md @@ -1,6 +1,6 @@ --- title: math variance -version: 0.63.0 +version: 0.64.0 usage: | Finds the variance of a list of numbers or tables --- diff --git a/book/commands/max.md b/book/commands/max.md new file mode 100644 index 00000000000..2c246a203ec --- /dev/null +++ b/book/commands/max.md @@ -0,0 +1,29 @@ +--- +title: max +version: 0.64.0 +usage: | + Creates a max expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> max ``` + +## Examples + +Max aggregation for a group by +```shell +> [[a b]; [one 2] [one 4] [two 1]] + | to-df + | group-by a + | agg (col b | max) +``` diff --git a/book/commands/mean.md b/book/commands/mean.md new file mode 100644 index 00000000000..4d3ce076235 --- /dev/null +++ b/book/commands/mean.md @@ -0,0 +1,29 @@ +--- +title: mean +version: 0.64.0 +usage: | + Creates a mean expression for an aggregation +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> mean ``` + +## Examples + +Mean aggregation for a group by +```shell +> [[a b]; [one 2] [one 4] [two 1]] + | to-df + | group-by a + | agg (col b | mean) +``` diff --git a/book/commands/median.md b/book/commands/median.md new file mode 100644 index 00000000000..4387bee2c21 --- /dev/null +++ b/book/commands/median.md @@ -0,0 +1,29 @@ +--- +title: median +version: 0.64.0 +usage: | + Creates a median expression for an aggregation +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> median ``` + +## Examples + +Median aggregation for a group by +```shell +> [[a b]; [one 2] [one 4] [two 1]] + | to-df + | group-by a + | agg (col b | median) +``` diff --git a/book/commands/merge.md b/book/commands/merge.md index d5d08e5e1c9..5cf7b52ac52 100644 --- a/book/commands/merge.md +++ b/book/commands/merge.md @@ -1,6 +1,6 @@ --- title: merge -version: 0.63.0 +version: 0.64.0 usage: | Merge a table into an input table --- @@ -33,3 +33,8 @@ Merge two records ```shell > {a: 1, b: 2} | merge { {c: 3} } ``` + +Merge two records with overlap key +```shell +> {a: 1, b: 3} | merge { {b: 2, c: 4} } +``` diff --git a/book/commands/metadata.md b/book/commands/metadata.md index 6688c0987b2..e703046e587 100644 --- a/book/commands/metadata.md +++ b/book/commands/metadata.md @@ -1,6 +1,6 @@ --- title: metadata -version: 0.63.0 +version: 0.64.0 usage: | Get the metadata for items in the stream --- diff --git a/book/commands/min.md b/book/commands/min.md new file mode 100644 index 00000000000..8ba96537b88 --- /dev/null +++ b/book/commands/min.md @@ -0,0 +1,29 @@ +--- +title: min +version: 0.64.0 +usage: | + Creates a min expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> min ``` + +## Examples + +Min aggregation for a group by +```shell +> [[a b]; [one 2] [one 4] [two 1]] + | to-df + | group-by a + | agg (col b | min) +``` diff --git a/book/commands/mkdir.md b/book/commands/mkdir.md index c880cdb0e0a..cb77ed5359b 100644 --- a/book/commands/mkdir.md +++ b/book/commands/mkdir.md @@ -1,6 +1,6 @@ --- title: mkdir -version: 0.63.0 +version: 0.64.0 usage: | Make directories, creates intermediary directories as required. --- diff --git a/book/commands/module.md b/book/commands/module.md index 5076bd6b2f9..0a910a88e93 100644 --- a/book/commands/module.md +++ b/book/commands/module.md @@ -1,6 +1,6 @@ --- title: module -version: 0.63.0 +version: 0.64.0 usage: | Define a custom module --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/move.md b/book/commands/move.md index 33491af6838..8d05823f140 100644 --- a/book/commands/move.md +++ b/book/commands/move.md @@ -1,6 +1,6 @@ --- title: move -version: 0.63.0 +version: 0.64.0 usage: | Move columns before or after other columns --- diff --git a/book/commands/mv.md b/book/commands/mv.md index 2c7a7736ae4..03ba4f5fd0b 100644 --- a/book/commands/mv.md +++ b/book/commands/mv.md @@ -1,6 +1,6 @@ --- title: mv -version: 0.63.0 +version: 0.64.0 usage: | Move files or directories. --- diff --git a/book/commands/n-unique.md b/book/commands/n-unique.md new file mode 100644 index 00000000000..98ae43f95e9 --- /dev/null +++ b/book/commands/n-unique.md @@ -0,0 +1,26 @@ +--- +title: n-unique +version: 0.64.0 +usage: | + creates a n-unique expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> n-unique ``` + +## Examples + +Creates a is n-unique expression from a column +```shell +> col a | n-unique +``` diff --git a/book/commands/n.md b/book/commands/n.md index c5f32523240..9f3facaf581 100644 --- a/book/commands/n.md +++ b/book/commands/n.md @@ -1,6 +1,6 @@ --- title: n -version: 0.63.0 +version: 0.64.0 usage: | Switch to the next shell. --- diff --git a/book/commands/nth.md b/book/commands/nth.md index b0c1cf50ecb..8a8e1282215 100644 --- a/book/commands/nth.md +++ b/book/commands/nth.md @@ -1,6 +1,6 @@ --- title: nth -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/nu-highlight.md b/book/commands/nu-highlight.md index bf556b9a9d9..63ac94a3086 100644 --- a/book/commands/nu-highlight.md +++ b/book/commands/nu-highlight.md @@ -1,6 +1,6 @@ --- title: nu-highlight -version: 0.63.0 +version: 0.64.0 usage: | Syntax highlight the input string. --- diff --git a/book/commands/open.md b/book/commands/open.md index a0d05bb7170..0f43b1cac51 100644 --- a/book/commands/open.md +++ b/book/commands/open.md @@ -1,6 +1,6 @@ --- title: open -version: 0.63.0 +version: 0.64.0 usage: | Load a file into a cell, converting to table if possible (avoid by appending '--raw'). --- diff --git a/book/commands/dfr_otherwise.md b/book/commands/otherwise.md similarity index 57% rename from book/commands/dfr_otherwise.md rename to book/commands/otherwise.md index fc4d55da4fb..5e44c18169c 100644 --- a/book/commands/dfr_otherwise.md +++ b/book/commands/otherwise.md @@ -1,6 +1,6 @@ --- -title: dfr otherwise -version: 0.63.1 +title: otherwise +version: 0.64.0 usage: | completes a when expression --- @@ -16,7 +16,7 @@ usage: | ## Signature -```> dfr otherwise (otherwise expression)``` +```> otherwise (otherwise expression)``` ## Parameters @@ -26,23 +26,23 @@ usage: | Create a when conditions ```shell -> dfr when ((dfr col a) > 2) 4 | dfr otherwise 5 +> when ((col a) > 2) 4 | otherwise 5 ``` Create a when conditions ```shell -> dfr when ((dfr col a) > 2) 4 | dfr when ((dfr col a) < 0) 6 | dfr otherwise 0 +> when ((col a) > 2) 4 | when ((col a) < 0) 6 | otherwise 0 ``` Create a new column for the dataframe ```shell > [[a b]; [6 2] [1 4] [4 1]] - | dfr to-lazy - | dfr with-column ( - dfr when ((dfr col a) > 2) 4 | dfr otherwise 5 | dfr as c + | to-lazy + | with-column ( + when ((col a) > 2) 4 | otherwise 5 | as c ) - | dfr with-column ( - dfr when ((dfr col a) > 5) 10 | dfr when ((dfr col a) < 2) 6 | dfr otherwise 0 | dfr as d + | with-column ( + when ((col a) > 5) 10 | when ((col a) < 2) 6 | otherwise 0 | as d ) - | dfr collect + | collect ``` diff --git a/book/commands/overlay.md b/book/commands/overlay.md index cfe09209d0b..04a032b983a 100644 --- a/book/commands/overlay.md +++ b/book/commands/overlay.md @@ -1,6 +1,6 @@ --- title: overlay -version: 0.63.0 +version: 0.64.0 usage: | Commands for manipulating overlays. --- @@ -20,6 +20,6 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` \ No newline at end of file diff --git a/book/commands/overlay_add.md b/book/commands/overlay_add.md index 57e6bc24d2b..55420f7e5bf 100644 --- a/book/commands/overlay_add.md +++ b/book/commands/overlay_add.md @@ -1,6 +1,6 @@ --- title: overlay add -version: 0.63.0 +version: 0.64.0 usage: | Add definitions from a module as an overlay --- @@ -24,8 +24,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/overlay_list.md b/book/commands/overlay_list.md index fb25fa5276a..3972ba2e24c 100644 --- a/book/commands/overlay_list.md +++ b/book/commands/overlay_list.md @@ -1,6 +1,6 @@ --- title: overlay list -version: 0.63.0 +version: 0.64.0 usage: | List all active overlays --- diff --git a/book/commands/overlay_new.md b/book/commands/overlay_new.md index 8a514d8c099..2d652711e9d 100644 --- a/book/commands/overlay_new.md +++ b/book/commands/overlay_new.md @@ -1,6 +1,6 @@ --- title: overlay new -version: 0.63.1 +version: 0.64.0 usage: | Create an empty overlay --- diff --git a/book/commands/overlay_remove.md b/book/commands/overlay_remove.md index 39631f5f2c0..cffe3a5c5a3 100644 --- a/book/commands/overlay_remove.md +++ b/book/commands/overlay_remove.md @@ -1,6 +1,6 @@ --- title: overlay remove -version: 0.63.0 +version: 0.64.0 usage: | Remove an active overlay --- @@ -25,8 +25,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/p.md b/book/commands/p.md index 16db4087ad5..a1d6e9197ad 100644 --- a/book/commands/p.md +++ b/book/commands/p.md @@ -1,6 +1,6 @@ --- title: p -version: 0.63.0 +version: 0.64.0 usage: | Switch to the previous shell. --- diff --git a/book/commands/par-each.md b/book/commands/par-each.md index 459379efc32..8ded63d95b3 100644 --- a/book/commands/par-each.md +++ b/book/commands/par-each.md @@ -1,6 +1,6 @@ --- title: par-each -version: 0.63.0 +version: 0.64.0 usage: | Run a block on each element of input in parallel --- diff --git a/book/commands/parse.md b/book/commands/parse.md index ef27a25ab0b..31ccc401d78 100644 --- a/book/commands/parse.md +++ b/book/commands/parse.md @@ -1,6 +1,6 @@ --- title: parse -version: 0.63.0 +version: 0.64.0 usage: | Parse columns from string data using a simple pattern. --- diff --git a/book/commands/path.md b/book/commands/path.md index 1b5b42f3e47..a3a9bfc24ad 100644 --- a/book/commands/path.md +++ b/book/commands/path.md @@ -1,6 +1,6 @@ --- title: path -version: 0.63.0 +version: 0.64.0 usage: | Explore and manipulate paths. --- @@ -26,8 +26,8 @@ There are three ways to represent a path: * As a structured path: a table with 'parent', 'stem', and 'extension' (and * 'prefix' on Windows) columns. This format is produced by the 'path parse' subcommand. -* As an inner list of path parts, e.g., '[[ / home viking spam.txt ]]'. - Splitting into parts is done by the `path split` command. +* As a list of path parts, e.g., '[ / home viking spam.txt ]'. Splitting into + parts is done by the `path split` command. All subcommands accept all three variants as an input. Furthermore, the 'path join' subcommand can be used to join the structured path or path parts back into diff --git a/book/commands/path_basename.md b/book/commands/path_basename.md index 3c011e625e5..7f6dbec5500 100644 --- a/book/commands/path_basename.md +++ b/book/commands/path_basename.md @@ -1,6 +1,6 @@ --- title: path basename -version: 0.63.0 +version: 0.64.0 usage: | Get the final component of a path --- diff --git a/book/commands/path_dirname.md b/book/commands/path_dirname.md index 7b34147afeb..b4856b9fe36 100644 --- a/book/commands/path_dirname.md +++ b/book/commands/path_dirname.md @@ -1,6 +1,6 @@ --- title: path dirname -version: 0.63.0 +version: 0.64.0 usage: | Get the parent directory of a path --- diff --git a/book/commands/path_exists.md b/book/commands/path_exists.md index a441a37e0e4..e377498ae92 100644 --- a/book/commands/path_exists.md +++ b/book/commands/path_exists.md @@ -1,6 +1,6 @@ --- title: path exists -version: 0.63.0 +version: 0.64.0 usage: | Check whether a path exists --- diff --git a/book/commands/path_expand.md b/book/commands/path_expand.md index a5ee8c69c53..40401da9101 100644 --- a/book/commands/path_expand.md +++ b/book/commands/path_expand.md @@ -1,6 +1,6 @@ --- title: path expand -version: 0.63.0 +version: 0.64.0 usage: | Try to expand a path to its absolute form --- diff --git a/book/commands/path_join.md b/book/commands/path_join.md index 31adc736314..70b58b27fcd 100644 --- a/book/commands/path_join.md +++ b/book/commands/path_join.md @@ -1,6 +1,6 @@ --- title: path join -version: 0.63.0 +version: 0.64.0 usage: | Join a structured path or a list of path parts. --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> path join (append) --columns``` +```> path join ...append --columns``` ## Parameters - - `append`: Path to append to the input + - `...append`: Path to append to the input - `--columns {table}`: Optionally operate by column path ## Notes @@ -35,6 +35,11 @@ Append a filename to a path > '/home/viking' | path join spam.txt ``` +Append a filename to a path +```shell +> '/home/viking' | path join spams this_spam.txt +``` + Append a filename to a path inside a column ```shell > ls | path join spam.txt -c [ name ] diff --git a/book/commands/path_parse.md b/book/commands/path_parse.md index dbcd5fbf413..b6ac7cf519b 100644 --- a/book/commands/path_parse.md +++ b/book/commands/path_parse.md @@ -1,6 +1,6 @@ --- title: path parse -version: 0.63.0 +version: 0.64.0 usage: | Convert a path into structured data. --- diff --git a/book/commands/path_relative-to.md b/book/commands/path_relative-to.md index a4daecff06e..b4fa0634123 100644 --- a/book/commands/path_relative-to.md +++ b/book/commands/path_relative-to.md @@ -1,6 +1,6 @@ --- title: path relative-to -version: 0.63.0 +version: 0.64.0 usage: | Get a path as relative to another path. --- diff --git a/book/commands/path_split.md b/book/commands/path_split.md index 777a9e47801..1913fb3e4b8 100644 --- a/book/commands/path_split.md +++ b/book/commands/path_split.md @@ -1,6 +1,6 @@ --- title: path split -version: 0.63.0 +version: 0.64.0 usage: | Split a path into parts by a separator. --- diff --git a/book/commands/path_type.md b/book/commands/path_type.md index be43b80ff64..6cbd85624d1 100644 --- a/book/commands/path_type.md +++ b/book/commands/path_type.md @@ -1,6 +1,6 @@ --- title: path type -version: 0.63.0 +version: 0.64.0 usage: | Get the type of the object a path refers to (e.g., file, dir, symlink) --- diff --git a/book/commands/pivot.md b/book/commands/pivot.md index ca8d1642774..751e2e99e8e 100644 --- a/book/commands/pivot.md +++ b/book/commands/pivot.md @@ -1,6 +1,6 @@ --- title: pivot -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/post.md b/book/commands/post.md index e1c2f6ca61e..88b40f85005 100644 --- a/book/commands/post.md +++ b/book/commands/post.md @@ -1,6 +1,6 @@ --- title: post -version: 0.63.0 +version: 0.64.0 usage: | Post a body to a URL. --- diff --git a/book/commands/prepend.md b/book/commands/prepend.md index acda17bfb23..c4928e7381e 100644 --- a/book/commands/prepend.md +++ b/book/commands/prepend.md @@ -1,6 +1,6 @@ --- title: prepend -version: 0.63.0 +version: 0.64.0 usage: | Prepend any number of rows to a table. --- diff --git a/book/commands/print.md b/book/commands/print.md index c958d5aa734..fe15c13c491 100644 --- a/book/commands/print.md +++ b/book/commands/print.md @@ -1,6 +1,6 @@ --- title: print -version: 0.63.0 +version: 0.64.0 usage: | Prints the values given --- @@ -16,12 +16,12 @@ usage: | ## Signature -```> print ...rest --no_newline``` +```> print ...rest --no-newline``` ## Parameters - `...rest`: the values to print - - `--no_newline`: print without inserting a newline for the line ending + - `--no-newline`: print without inserting a newline for the line ending ## Examples diff --git a/book/commands/ps.md b/book/commands/ps.md index d7c88936d81..a40e6dfa22c 100644 --- a/book/commands/ps.md +++ b/book/commands/ps.md @@ -1,6 +1,6 @@ --- title: ps -version: 0.63.0 +version: 0.64.0 usage: | View information about system processes. --- diff --git a/book/commands/dfr_column.md b/book/commands/quantile.md similarity index 53% rename from book/commands/dfr_column.md rename to book/commands/quantile.md index 54b318913ce..e3bdd5df8db 100644 --- a/book/commands/dfr_column.md +++ b/book/commands/quantile.md @@ -1,8 +1,8 @@ --- -title: dfr column -version: 0.63.0 +title: quantile +version: 0.64.0 usage: | - Returns the selected column + Aggregates the columns to the selected quantile --- + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> std ``` + +## Examples + +Std aggregation for a group by +```shell +> [[a b]; [one 2] [one 2] [two 1] [two 1]] + | to-df + | group-by a + | agg (col b | std) +``` diff --git a/book/commands/str.md b/book/commands/str.md index e70c9187a52..72177e73c94 100644 --- a/book/commands/str.md +++ b/book/commands/str.md @@ -1,6 +1,6 @@ --- title: str -version: 0.63.0 +version: 0.64.0 usage: | Various commands for working with string data --- diff --git a/book/commands/str_camel-case.md b/book/commands/str_camel-case.md index 678b87bc036..212a77c86e0 100644 --- a/book/commands/str_camel-case.md +++ b/book/commands/str_camel-case.md @@ -1,6 +1,6 @@ --- title: str camel-case -version: 0.63.0 +version: 0.64.0 usage: | Convert a string to camelCase --- diff --git a/book/commands/str_capitalize.md b/book/commands/str_capitalize.md index 71b738c63b1..ce9d1844e05 100644 --- a/book/commands/str_capitalize.md +++ b/book/commands/str_capitalize.md @@ -1,6 +1,6 @@ --- title: str capitalize -version: 0.63.0 +version: 0.64.0 usage: | Capitalize first letter of text --- diff --git a/book/commands/str_collect.md b/book/commands/str_collect.md index 670335e17e0..a1c0787a4e4 100644 --- a/book/commands/str_collect.md +++ b/book/commands/str_collect.md @@ -1,6 +1,6 @@ --- title: str collect -version: 0.63.0 +version: 0.64.0 usage: | Concatenate multiple strings into a single string, with an optional separator between each --- diff --git a/book/commands/str_contains.md b/book/commands/str_contains.md index e48c653857a..f6998e3c1cd 100644 --- a/book/commands/str_contains.md +++ b/book/commands/str_contains.md @@ -1,6 +1,6 @@ --- title: str contains -version: 0.63.0 +version: 0.64.0 usage: | Checks if string contains pattern --- diff --git a/book/commands/str_downcase.md b/book/commands/str_downcase.md index 91b39151793..2a1b7ee92af 100644 --- a/book/commands/str_downcase.md +++ b/book/commands/str_downcase.md @@ -1,6 +1,6 @@ --- title: str downcase -version: 0.63.0 +version: 0.64.0 usage: | Make text lowercase --- diff --git a/book/commands/str_ends-with.md b/book/commands/str_ends-with.md index fc7516017a7..660c0b956fb 100644 --- a/book/commands/str_ends-with.md +++ b/book/commands/str_ends-with.md @@ -1,6 +1,6 @@ --- title: str ends-with -version: 0.63.0 +version: 0.64.0 usage: | Check if a string ends with a pattern --- diff --git a/book/commands/str_find-replace.md b/book/commands/str_find-replace.md index bf3bc4182d6..c987b5dd143 100644 --- a/book/commands/str_find-replace.md +++ b/book/commands/str_find-replace.md @@ -1,6 +1,6 @@ --- title: str find-replace -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/str_index-of.md b/book/commands/str_index-of.md index 273fd52a396..f7e6bb1cca5 100644 --- a/book/commands/str_index-of.md +++ b/book/commands/str_index-of.md @@ -1,6 +1,6 @@ --- title: str index-of -version: 0.63.0 +version: 0.64.0 usage: | Returns start index of first occurrence of pattern in string, or -1 if no match --- diff --git a/book/commands/str_kebab-case.md b/book/commands/str_kebab-case.md index c1430ae6f97..c8fc5e2a792 100644 --- a/book/commands/str_kebab-case.md +++ b/book/commands/str_kebab-case.md @@ -1,6 +1,6 @@ --- title: str kebab-case -version: 0.63.0 +version: 0.64.0 usage: | Convert a string to kebab-case --- diff --git a/book/commands/str_length.md b/book/commands/str_length.md index de94713b11d..0f8b74c2f6c 100644 --- a/book/commands/str_length.md +++ b/book/commands/str_length.md @@ -1,6 +1,6 @@ --- title: str length -version: 0.63.0 +version: 0.64.0 usage: | Output the length of any strings in the pipeline --- diff --git a/book/commands/str_lpad.md b/book/commands/str_lpad.md index 6d7e436f201..2a8bc2f723f 100644 --- a/book/commands/str_lpad.md +++ b/book/commands/str_lpad.md @@ -1,6 +1,6 @@ --- title: str lpad -version: 0.63.0 +version: 0.64.0 usage: | Left-pad a string to a specific length --- diff --git a/book/commands/str_pascal-case.md b/book/commands/str_pascal-case.md index caffa224dbd..532cf22a34c 100644 --- a/book/commands/str_pascal-case.md +++ b/book/commands/str_pascal-case.md @@ -1,6 +1,6 @@ --- title: str pascal-case -version: 0.63.0 +version: 0.64.0 usage: | Convert a string to PascalCase --- diff --git a/book/commands/str_replace.md b/book/commands/str_replace.md index 9ffd9151df6..0012f3af955 100644 --- a/book/commands/str_replace.md +++ b/book/commands/str_replace.md @@ -1,6 +1,6 @@ --- title: str replace -version: 0.63.0 +version: 0.64.0 usage: | Find and replace text --- diff --git a/book/commands/str_reverse.md b/book/commands/str_reverse.md index c7315d05f2c..30d1bcdd20f 100644 --- a/book/commands/str_reverse.md +++ b/book/commands/str_reverse.md @@ -1,6 +1,6 @@ --- title: str reverse -version: 0.63.0 +version: 0.64.0 usage: | Reverse every string in the pipeline --- diff --git a/book/commands/str_rpad.md b/book/commands/str_rpad.md index 353d1d6679e..fd802230681 100644 --- a/book/commands/str_rpad.md +++ b/book/commands/str_rpad.md @@ -1,6 +1,6 @@ --- title: str rpad -version: 0.63.0 +version: 0.64.0 usage: | Right-pad a string to a specific length --- diff --git a/book/commands/str_screaming-snake-case.md b/book/commands/str_screaming-snake-case.md index 028c91d34d1..aeb674f3008 100644 --- a/book/commands/str_screaming-snake-case.md +++ b/book/commands/str_screaming-snake-case.md @@ -1,6 +1,6 @@ --- title: str screaming-snake-case -version: 0.63.0 +version: 0.64.0 usage: | Convert a string to SCREAMING_SNAKE_CASE --- diff --git a/book/commands/str_snake-case.md b/book/commands/str_snake-case.md index 3355a63fae2..d7acd50bfde 100644 --- a/book/commands/str_snake-case.md +++ b/book/commands/str_snake-case.md @@ -1,6 +1,6 @@ --- title: str snake-case -version: 0.63.0 +version: 0.64.0 usage: | Convert a string to snake_case --- diff --git a/book/commands/str_starts-with.md b/book/commands/str_starts-with.md index b0e5b47e9e8..029b3645189 100644 --- a/book/commands/str_starts-with.md +++ b/book/commands/str_starts-with.md @@ -1,6 +1,6 @@ --- title: str starts-with -version: 0.63.0 +version: 0.64.0 usage: | Check if string starts with a pattern --- diff --git a/book/commands/str_substring.md b/book/commands/str_substring.md index 7b3f0f7f701..3c6b2132c92 100644 --- a/book/commands/str_substring.md +++ b/book/commands/str_substring.md @@ -1,8 +1,8 @@ --- title: str substring -version: 0.63.0 +version: 0.64.0 usage: | - Get part of a string + Get part of a string. Note that the start is included but the end is excluded, and that the first character of a string is index 0. --- + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> sum ``` + +## Examples + +Sum aggregation for a group by +```shell +> [[a b]; [one 2] [one 4] [two 1]] + | to-df + | group-by a + | agg (col b | sum) +``` diff --git a/book/commands/sys.md b/book/commands/sys.md index 956bd9f8ebe..d8b10db2bdb 100644 --- a/book/commands/sys.md +++ b/book/commands/sys.md @@ -1,6 +1,6 @@ --- title: sys -version: 0.63.0 +version: 0.64.0 usage: | View information about the system. --- diff --git a/book/commands/table.md b/book/commands/table.md index 46964cabe7f..9c2c290ddd1 100644 --- a/book/commands/table.md +++ b/book/commands/table.md @@ -1,6 +1,6 @@ --- title: table -version: 0.63.0 +version: 0.64.0 usage: | Render the table. --- @@ -16,12 +16,13 @@ usage: | ## Signature -```> table --start-number --list``` +```> table --start-number --list --width``` ## Parameters - `--start-number {int}`: row number to start viewing from - `--list`: list available table modes/themes + - `--width {int}`: number of terminal columns wide (not output columns) ## Examples diff --git a/book/commands/take.md b/book/commands/take.md index 5ab5ed11f1e..606c289e738 100644 --- a/book/commands/take.md +++ b/book/commands/take.md @@ -1,6 +1,6 @@ --- title: take -version: 0.63.0 +version: 0.64.0 usage: | Take the first n elements of the input. --- diff --git a/book/commands/take_until.md b/book/commands/take_until.md index 6dff828596b..7239b1cbad2 100644 --- a/book/commands/take_until.md +++ b/book/commands/take_until.md @@ -1,6 +1,6 @@ --- title: take until -version: 0.63.0 +version: 0.64.0 usage: | Take elements of the input until a predicate is true. --- diff --git a/book/commands/take_while.md b/book/commands/take_while.md index 502bad3147c..1f04fbfd27a 100644 --- a/book/commands/take_while.md +++ b/book/commands/take_while.md @@ -1,6 +1,6 @@ --- title: take while -version: 0.63.0 +version: 0.64.0 usage: | Take elements of the input while a predicate is true. --- diff --git a/book/commands/term_size.md b/book/commands/term_size.md index e1eeefa4787..39e3daa1ee8 100644 --- a/book/commands/term_size.md +++ b/book/commands/term_size.md @@ -1,6 +1,6 @@ --- title: term size -version: 0.63.0 +version: 0.64.0 usage: | Returns the terminal size --- diff --git a/book/commands/dfr_to-nu.md b/book/commands/to-nu.md similarity index 84% rename from book/commands/dfr_to-nu.md rename to book/commands/to-nu.md index 5d5e7396ecb..1c4083aa73e 100644 --- a/book/commands/dfr_to-nu.md +++ b/book/commands/to-nu.md @@ -1,6 +1,6 @@ --- -title: dfr to-nu -version: 0.63.0 +title: to-nu +version: 0.64.0 usage: | Convert expression to a nu value for access and exploration --- @@ -16,11 +16,11 @@ usage: | ## Signature -```> dfr to-nu ``` +```> to-nu ``` ## Examples Convert a col expression into a nushell value ```shell -> dfr col col_a | dfr to-nu +> col a | to-nu ``` diff --git a/book/commands/to.md b/book/commands/to.md index a57e1ac30d0..dcdad0c23fe 100644 --- a/book/commands/to.md +++ b/book/commands/to.md @@ -1,6 +1,6 @@ --- title: to -version: 0.63.0 +version: 0.64.0 usage: | Translate structured data to a format --- diff --git a/book/commands/to_csv.md b/book/commands/to_csv.md index e4ee7963b55..c3c48c5ef5f 100644 --- a/book/commands/to_csv.md +++ b/book/commands/to_csv.md @@ -1,6 +1,6 @@ --- title: to csv -version: 0.63.0 +version: 0.64.0 usage: | Convert table into .csv text --- diff --git a/book/commands/to_html.md b/book/commands/to_html.md index e10da806338..fa4fc38746c 100644 --- a/book/commands/to_html.md +++ b/book/commands/to_html.md @@ -1,6 +1,6 @@ --- title: to html -version: 0.63.0 +version: 0.64.0 usage: | Convert table into simple HTML --- diff --git a/book/commands/to_json.md b/book/commands/to_json.md index 9dbbc33d2f3..9698b070764 100644 --- a/book/commands/to_json.md +++ b/book/commands/to_json.md @@ -1,6 +1,6 @@ --- title: to json -version: 0.63.0 +version: 0.64.0 usage: | Converts table data into JSON text. --- diff --git a/book/commands/to_md.md b/book/commands/to_md.md index b60afc3aeeb..798076c0b83 100644 --- a/book/commands/to_md.md +++ b/book/commands/to_md.md @@ -1,6 +1,6 @@ --- title: to md -version: 0.63.0 +version: 0.64.0 usage: | Convert table into simple Markdown --- diff --git a/book/commands/to_nuon.md b/book/commands/to_nuon.md index ef91067a179..373842552a4 100644 --- a/book/commands/to_nuon.md +++ b/book/commands/to_nuon.md @@ -1,6 +1,6 @@ --- title: to nuon -version: 0.63.0 +version: 0.64.0 usage: | Converts table data into Nuon (Nushell Object Notation) text. --- @@ -20,7 +20,7 @@ usage: | ## Examples -Outputs a nuon string representing the contents of this table +Outputs a nuon string representing the contents of this list ```shell > [1 2 3] | to nuon ``` diff --git a/book/commands/to_text.md b/book/commands/to_text.md index a9257aff8ce..31e054269ee 100644 --- a/book/commands/to_text.md +++ b/book/commands/to_text.md @@ -1,6 +1,6 @@ --- title: to text -version: 0.63.0 +version: 0.64.0 usage: | Converts data into simple text. --- diff --git a/book/commands/to_toml.md b/book/commands/to_toml.md index 168ee176413..b3be5e08179 100644 --- a/book/commands/to_toml.md +++ b/book/commands/to_toml.md @@ -1,6 +1,6 @@ --- title: to toml -version: 0.63.0 +version: 0.64.0 usage: | Convert table into .toml text --- diff --git a/book/commands/to_tsv.md b/book/commands/to_tsv.md index ed6d9d056b7..4c4cace82e2 100644 --- a/book/commands/to_tsv.md +++ b/book/commands/to_tsv.md @@ -1,6 +1,6 @@ --- title: to tsv -version: 0.63.0 +version: 0.64.0 usage: | Convert table into .tsv text --- diff --git a/book/commands/to_url.md b/book/commands/to_url.md index 3c47442552c..f7850aaf793 100644 --- a/book/commands/to_url.md +++ b/book/commands/to_url.md @@ -1,6 +1,6 @@ --- title: to url -version: 0.63.0 +version: 0.64.0 usage: | Convert table into url-encoded text --- diff --git a/book/commands/to_xml.md b/book/commands/to_xml.md index c324f6fc4a6..ae5675662dc 100644 --- a/book/commands/to_xml.md +++ b/book/commands/to_xml.md @@ -1,6 +1,6 @@ --- title: to xml -version: 0.63.0 +version: 0.64.0 usage: | Convert table into .xml text --- diff --git a/book/commands/to_yaml.md b/book/commands/to_yaml.md index 416e87ce8f3..9456bd28d9c 100644 --- a/book/commands/to_yaml.md +++ b/book/commands/to_yaml.md @@ -1,6 +1,6 @@ --- title: to yaml -version: 0.63.0 +version: 0.64.0 usage: | Convert table into .yaml/.yml text --- diff --git a/book/commands/touch.md b/book/commands/touch.md index 5b7e83e417e..58e6796ee5d 100644 --- a/book/commands/touch.md +++ b/book/commands/touch.md @@ -1,6 +1,6 @@ --- title: touch -version: 0.63.0 +version: 0.64.0 usage: | Creates one or more files. --- diff --git a/book/commands/transpose.md b/book/commands/transpose.md index 3a2e5ee2b5c..e0a9b8ba2c0 100644 --- a/book/commands/transpose.md +++ b/book/commands/transpose.md @@ -1,6 +1,6 @@ --- title: transpose -version: 0.63.0 +version: 0.64.0 usage: | Transposes the table contents so rows become columns and columns become rows. --- @@ -16,13 +16,14 @@ usage: | ## Signature -```> transpose ...rest --header-row --ignore-titles``` +```> transpose ...rest --header-row --ignore-titles --as-record``` ## Parameters - `...rest`: the names to give columns once transposed - `--header-row`: treat the first row as column names - `--ignore-titles`: don't transpose the column names into values + - `--as-record`: transfer to record if the result is a table and contains only one row ## Examples @@ -40,3 +41,8 @@ Transposes the table without column names and specify a new column name ```shell > echo [[c1 c2]; [1 2]] | transpose -i val ``` + +Transfer back to record with -d flag +```shell +> echo {c1: 1, c2: 2} | transpose | transpose -i -r -d +``` diff --git a/book/commands/tutor.md b/book/commands/tutor.md index 13927658402..8a5ed0e8419 100644 --- a/book/commands/tutor.md +++ b/book/commands/tutor.md @@ -1,6 +1,6 @@ --- title: tutor -version: 0.63.0 +version: 0.64.0 usage: | Run the tutorial. To begin, run: tutor --- diff --git a/book/commands/unalias.md b/book/commands/unalias.md index 1f72c41c7a2..c495c2ca505 100644 --- a/book/commands/unalias.md +++ b/book/commands/unalias.md @@ -1,6 +1,6 @@ --- title: unalias -version: 0.63.0 +version: 0.64.0 usage: | Deprecated command --- diff --git a/book/commands/uniq.md b/book/commands/uniq.md index 26d03eea015..8b1a5edb643 100644 --- a/book/commands/uniq.md +++ b/book/commands/uniq.md @@ -1,6 +1,6 @@ --- title: uniq -version: 0.63.0 +version: 0.64.0 usage: | Return the unique rows. --- diff --git a/book/commands/update.md b/book/commands/update.md index 55f70258383..51963bdf231 100644 --- a/book/commands/update.md +++ b/book/commands/update.md @@ -1,6 +1,6 @@ --- title: update -version: 0.63.0 +version: 0.64.0 usage: | Update an existing column to have a new value. --- diff --git a/book/commands/update_cells.md b/book/commands/update_cells.md index 0ccc6aaffb3..8b1a84f02c5 100644 --- a/book/commands/update_cells.md +++ b/book/commands/update_cells.md @@ -1,6 +1,6 @@ --- title: update cells -version: 0.63.0 +version: 0.64.0 usage: | Update the table cells. --- diff --git a/book/commands/upsert.md b/book/commands/upsert.md index 752fde8b746..7b21aabd2c3 100644 --- a/book/commands/upsert.md +++ b/book/commands/upsert.md @@ -1,6 +1,6 @@ --- title: upsert -version: 0.63.0 +version: 0.64.0 usage: | Update an existing column to have a new value, or insert a new column. --- diff --git a/book/commands/url.md b/book/commands/url.md index 68fdbcbf08e..d01b4352a76 100644 --- a/book/commands/url.md +++ b/book/commands/url.md @@ -1,6 +1,6 @@ --- title: url -version: 0.63.0 +version: 0.64.0 usage: | Apply url function. --- diff --git a/book/commands/url_host.md b/book/commands/url_host.md index 9183d5a99e6..0c5d002fc92 100644 --- a/book/commands/url_host.md +++ b/book/commands/url_host.md @@ -1,6 +1,6 @@ --- title: url host -version: 0.63.0 +version: 0.64.0 usage: | Get the host of a URL --- diff --git a/book/commands/url_path.md b/book/commands/url_path.md index c154f7e3956..0cc46e74bbb 100644 --- a/book/commands/url_path.md +++ b/book/commands/url_path.md @@ -1,6 +1,6 @@ --- title: url path -version: 0.63.0 +version: 0.64.0 usage: | Get the path of a URL --- diff --git a/book/commands/url_query.md b/book/commands/url_query.md index 9fd7ec4689d..1f82f077ac2 100644 --- a/book/commands/url_query.md +++ b/book/commands/url_query.md @@ -1,6 +1,6 @@ --- title: url query -version: 0.63.0 +version: 0.64.0 usage: | Get the query string of a URL --- diff --git a/book/commands/url_scheme.md b/book/commands/url_scheme.md index 17a9b8e0415..a8cb7446b9a 100644 --- a/book/commands/url_scheme.md +++ b/book/commands/url_scheme.md @@ -1,6 +1,6 @@ --- title: url scheme -version: 0.63.0 +version: 0.64.0 usage: | Get the scheme (e.g. http, file) of a URL --- diff --git a/book/commands/use.md b/book/commands/use.md index ede5de5b49c..66565fc5178 100644 --- a/book/commands/use.md +++ b/book/commands/use.md @@ -1,6 +1,6 @@ --- title: use -version: 0.63.0 +version: 0.64.0 usage: | Use definitions from a module --- @@ -24,8 +24,8 @@ usage: | ## Notes ```text -This command is a parser keyword. For details, check -https://www.nushell.sh/book/thinking_in_nushell.html#parsing-and-evaluation-are-different-stages +This command is a parser keyword. For details, check: + https://www.nushell.sh/book/thinking_in_nushell.html ``` ## Examples diff --git a/book/commands/var.md b/book/commands/var.md new file mode 100644 index 00000000000..43023e1042c --- /dev/null +++ b/book/commands/var.md @@ -0,0 +1,29 @@ +--- +title: var +version: 0.64.0 +usage: | + Create a var expression for an aggregation +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> var ``` + +## Examples + +Var aggregation for a group by +```shell +> [[a b]; [one 2] [one 2] [two 1] [two 1]] + | to-df + | group-by a + | agg (col b | var) +``` diff --git a/book/commands/version.md b/book/commands/version.md index 92cb4521a05..d055fa7f620 100644 --- a/book/commands/version.md +++ b/book/commands/version.md @@ -1,6 +1,6 @@ --- title: version -version: 0.63.0 +version: 0.64.0 usage: | Display Nu version. --- diff --git a/book/commands/view-source.md b/book/commands/view-source.md index 6877fcb4de5..19137d15651 100644 --- a/book/commands/view-source.md +++ b/book/commands/view-source.md @@ -1,6 +1,6 @@ --- title: view-source -version: 0.63.0 +version: 0.64.0 usage: | View a block, module, or a definition --- diff --git a/book/commands/watch.md b/book/commands/watch.md index 32577a6c76e..dc9c17bc283 100644 --- a/book/commands/watch.md +++ b/book/commands/watch.md @@ -1,6 +1,6 @@ --- title: watch -version: 0.63.0 +version: 0.64.0 usage: | Watch for file changes and execute Nu code when they happen. --- diff --git a/book/commands/when.md b/book/commands/when.md new file mode 100644 index 00000000000..ac419957890 --- /dev/null +++ b/book/commands/when.md @@ -0,0 +1,49 @@ +--- +title: when +version: 0.64.0 +usage: | + Creates and modifies a when expression +--- + + + +# {{ frontmatter.title }} + +
{{ frontmatter.usage }}
+ +## Signature + +```> when (when expression) (then expression)``` + +## Parameters + + - `when expression`: when expression used for matching + - `then expression`: expression that will be applied when predicate is true + +## Examples + +Create a when conditions +```shell +> when ((col a) > 2) 4 +``` + +Create a when conditions +```shell +> when ((col a) > 2) 4 | when ((col a) < 0) 6 +``` + +Create a new column for the dataframe +```shell +> [[a b]; [6 2] [1 4] [4 1]] + | to-lazy + | with-column ( + when ((col a) > 2) 4 | otherwise 5 | as c + ) + | with-column ( + when ((col a) > 5) 10 | when ((col a) < 2) 6 | otherwise 0 | as d + ) + | collect +``` diff --git a/book/commands/where.md b/book/commands/where.md index 74fd6bb45be..c0a5f598411 100644 --- a/book/commands/where.md +++ b/book/commands/where.md @@ -1,6 +1,6 @@ --- title: where -version: 0.63.0 +version: 0.64.0 usage: | Filter values based on a condition. --- diff --git a/book/commands/which.md b/book/commands/which.md index 26bb5073838..f9e0f5bee1d 100644 --- a/book/commands/which.md +++ b/book/commands/which.md @@ -1,6 +1,6 @@ --- title: which -version: 0.63.0 +version: 0.64.0 usage: | Finds a program file, alias or custom command. --- diff --git a/book/commands/window.md b/book/commands/window.md index 5b2601e9e5b..49e27af3c88 100644 --- a/book/commands/window.md +++ b/book/commands/window.md @@ -1,6 +1,6 @@ --- title: window -version: 0.63.0 +version: 0.64.0 usage: | Creates a sliding window of `window_size` that slide by n rows/elements across input. --- diff --git a/book/commands/with-env.md b/book/commands/with-env.md index b3d97dca032..e4463050ce9 100644 --- a/book/commands/with-env.md +++ b/book/commands/with-env.md @@ -1,6 +1,6 @@ --- title: with-env -version: 0.63.0 +version: 0.64.0 usage: | Runs a block with an environment variable set. --- diff --git a/book/commands/wrap.md b/book/commands/wrap.md index 942e161650c..0168c4286e0 100644 --- a/book/commands/wrap.md +++ b/book/commands/wrap.md @@ -1,6 +1,6 @@ --- title: wrap -version: 0.63.0 +version: 0.64.0 usage: | Wrap the value into a column. --- diff --git a/book/commands/zip.md b/book/commands/zip.md index debeb163751..ba7258f812e 100644 --- a/book/commands/zip.md +++ b/book/commands/zip.md @@ -1,6 +1,6 @@ --- title: zip -version: 0.63.0 +version: 0.64.0 usage: | Combine a stream with the input --- diff --git a/book/make_docs.nu b/book/make_docs.nu index 25a2f173eca..38600f7242e 100644 --- a/book/make_docs.nu +++ b/book/make_docs.nu @@ -8,7 +8,7 @@ if $book_exists == false { exit --now } -for command in ($nu.scope.commands | where is_custom == false && is_extern == false) { +for command in ($nu.scope.commands | where is_custom == false && is_extern == false | sort-by category) { # this is going in the frontmatter as a multiline YAML string, so indentation matters let indented_usage = ($command.usage | lines | each {|it| $" ($it)"} | str collect (char nl)) @@ -96,6 +96,7 @@ $"($example.description) ) let safe_name = ($command.command | str replace '\?' '' | str replace ' ' '_') + let safe_name = if ($command.category =~ 'frame') { $'_($safe_name)' } else { $safe_name } $doc | save --raw $"./book/commands/($safe_name).md" $"./book/commands/($safe_name).md" } | length | $"($in) commands written"