doc iotas

Author: micans

examples/make-multi-select.sh

@@ -9,7 +9,7 @@ EOT
 
 while IFS=# read command description; do
 cat <<EOT
-## $description
+### $description
 \`\`\`
 > $command
 
@@ -32,5 +32,6 @@ echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick -A '.*'/x::__,sq#Create a new column name
 echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick  '.*'//x::__,sq#Using the double slash has the same effect, but columns are grouped pairwise
 echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick  '.*'//_pct::__:c^1,pct#This can be useful when expressing as a percentage, here relative to column c
 echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick -A '.*'/x::__,sq '.*'/y::__,sq,sq#Multiple computations are possible
-echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick -i '.*'::'.*',addall#A (not particularly useful) curiosity - the first column is 3+4+5=12, then the second column is 12+4+5=21, the third 12+21+5
+echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick -i '.*'::'.*',addall#A (not very useful) curiosity - the first column is a = (a=3)+(b=4)+(c=5)=12, then the second is b = (a=12)+(b=4)+(c=5)=21, the third is c = (a=12)+(b=21)+(c=5)
+echo -e "a\\tb\\tc\\n3\\t4\\t5" | pick -Ai '.*'/x::'.*',addall#(continued) this behaviour disappears if the values are stored in a new name
 EOI

examples/multi-select.md

@@ -1,6 +1,6 @@
 # Examples of selecting and changing multiple columns simultaneously
 
-## Select all columns for output (normally achieved with -A)
+### Select all columns for output (normally achieved with -A)
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick '.*'
 
@@ -9,23 +9,23 @@ a       b       c
 ```
 
 
-## Select all columns, apply the same computation (cannot be empty however)
+### Select all columns, apply the same computation (cannot be empty however)
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick '.*'::
 
 Compute cannot be empty
 ```
 
 
-## The -i in-place options is required to allow potential overwriting of existing columns
+### The -i in-place options is required to allow potential overwriting of existing columns
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick '.*'::^foo
 
 Name a already defined (use -i for in-place change)
 ```
 
 
-## Computation consisting of the constant value 'foo'
+### Computation consisting of the constant value 'foo'
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -i '.*'::^foo
 
@@ -34,7 +34,7 @@ foo     foo     foo
 ```
 
 
-## Computation consisting of the column itself
+### Computation consisting of the column itself
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -i '.*'::__
 
@@ -43,7 +43,7 @@ a       b       c
 ```
 
 
-## Computation consisting of the column duplicated
+### Computation consisting of the column duplicated
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -i '.*'::__:__
 
@@ -52,7 +52,7 @@ a       b       c
 ```
 
 
-## Computation consisting of the column squared
+### Computation consisting of the column squared
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -i '.*'::__,sq
 
@@ -61,7 +61,7 @@ a       b       c
 ```
 
 
-## Create a new column name by adding 'x'; now -i is not needed, -A shows the original columns
+### Create a new column name by adding 'x'; now -i is not needed, -A shows the original columns
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -A '.*'/x::__,sq
 
@@ -70,7 +70,7 @@ a       b       c       ax      bx      cx
 ```
 
 
-## Using the double slash has the same effect, but columns are grouped pairwise
+### Using the double slash has the same effect, but columns are grouped pairwise
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick  '.*'//x::__,sq
 
@@ -79,7 +79,7 @@ a       ax      b       bx      c       cx
 ```
 
 
-## This can be useful when expressing as a percentage, here relative to column c
+### This can be useful when expressing as a percentage, here relative to column c
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick  '.*'//_pct::__:c^1,pct
 
@@ -88,7 +88,7 @@ a       a_pct   b       b_pct   c       c_pct
 ```
 
 
-## Multiple computations are possible
+### Multiple computations are possible
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -A '.*'/x::__,sq '.*'/y::__,sq,sq
 
@@ -97,7 +97,7 @@ a       b       c       ax      bx      cx      ay      by      cy
 ```
 
 
-## A (not particularly useful) curiosity - the first column is 3+4+5=12, then the second column is 12+4+5=21, the third 12+21+5
+### A (not very useful) curiosity - the first column is a = (a=3)+(b=4)+(c=5)=12, then the second is b = (a=12)+(b=4)+(c=5)=21, the third is c = (a=12)+(b=21)+(c=5)
 ```
 > echo -e "a\tb\tc\n3\t4\t5" | pick -i '.*'::'.*',addall
 
@@ -106,3 +106,12 @@ a       b       c
 ```
 
 
+### (continued) this behaviour disappears if the values are stored in a new name
+```
+> echo -e "a\tb\tc\n3\t4\t5" | pick -Ai '.*'/x::'.*',addall
+
+a       b       c       ax      bx      cx
+3       4       5       12      12      12
+```
+
+