Improve docstrings of Indicator and LowHigh

Author: juliohm

src/transforms/indicator.jl

@@ -3,19 +3,17 @@ const SCALES = [:quantile, :linear]
 """
     Indicator(col; k=10, scale=:quantile, categ=false)
 
-Transforms continuous variable into `k` indicator variables defined by
-half-intervals of `col` values in a given `scale`. Optionally, specify the `categ`
-option to return binary categorical values as opposed to raw 1s and 0s.
+Given a sequence of `k` increasing threshold values `t1 < t2 < ... < tk`,
+the transform converts a continuous variable `z` into a sequence of `k`
+variables `z <= t1`, `z <= t2`, ..., `z <= tk`.
 
-Given a sequence of increasing threshold values `t1 < t2 < ... < tk`, the indicator
-transform converts a continuous variable `Z` into a sequence of `k` variables
-`Z_1 = Z <= t1`, `Z_2 = Z <= t2`, ..., `Z_k = Z <= tk`.
+The threshold values are a function of the `scale` option, which can be:
 
-## Scales:
+* `:quantile` - thresholds are calculated using `quantile`s
+* `:linear` - thresholds are calculated using direct values
 
-* `:quantile` - threshold values are calculated using the `quantile(Z, p)` function
-  with a linear range of probabilities.
-* `:linear` - threshold values are calculated using a linear range.
+The `categ` option can be used to enforce binary categorical values
+instead of raw `1` and `0` integer values.
 
 ## Examples
 

src/transforms/lowhigh.jl

@@ -5,19 +5,18 @@
 """
     LowHigh(; low=0.25, high=0.75)
 
-Applies the LowHigh transform to all columns of the table.
-The LowHigh transform of the column `x` is defined by `(x .- xl) ./ (xh - xl)`,
+Transforms a column `x` into `(x .- xl) ./ (xh - xl)`,
 where `xl = quantile(x, low)` and `xh = quantile(x, high)`.
 
     LowHigh(col₁, col₂, ..., colₙ; low=0.25, high=0.75)
     LowHigh([col₁, col₂, ..., colₙ]; low=0.25, high=0.75)
     LowHigh((col₁, col₂, ..., colₙ); low=0.25, high=0.75)
 
-Applies the LowHigh transform on columns `col₁`, `col₂`, ..., `colₙ`.
+Applies the transform to columns `col₁`, `col₂`, ..., `colₙ`.
 
     LowHigh(regex; low=0.25, high=0.75)
 
-Applies the LowHigh transform on columns that match with `regex`.
+Applies the transform to columns that match with `regex`.
 
 ## Examples