Skip to content

Commit 179d631

Browse files
authored
changed Formula to FormulaTerm in documentation and docstrings (#322)
Fixes #321.
1 parent e029ef4 commit 179d631

File tree

3 files changed

+5
-5
lines changed

3 files changed

+5
-5
lines changed

docs/src/contrasts.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -63,7 +63,7 @@ ContrastsCoding
6363

6464
## Further details
6565

66-
### Categorical variables in `Formula`s
66+
### Categorical variables in `FormulaTerm`s
6767

6868
Generating model matrices from multiple variables, some of which are
6969
categorical, requires special care. The reason for this is that rank-$k-1$
@@ -93,7 +93,7 @@ categorical `a`, `b`, and `c`:
9393
* The `a` in `a&b` is *non-redundant* because it aliases `b`, which is not
9494
present anywhere else in the formula.
9595

96-
When constructing a `ModelFrame` from a `Formula`, each term is checked for
96+
When constructing a `ModelFrame` from a `FormulaTerm`, each term is checked for
9797
non-redundant categorical variables. Any such non-redundant variables are
9898
"promoted" to full rank in that term by using [`FullDummyCoding`](@ref) instead
9999
of the contrasts used elsewhere for that variable.

src/contrasts.jl

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -263,7 +263,7 @@ Not exported but included here for the sake of completeness.
263263
Needed internally for some situations where a categorical variable with ``k``
264264
levels needs to be converted into ``k`` model matrix columns instead of the
265265
standard ``k-1``. This occurs when there are missing lower-order terms, as in
266-
discussed below in [Categorical variables in Formulas](@ref).
266+
discussed below in [Categorical variables in FormulaTerms](@ref).
267267
268268
# Examples
269269

src/formula.jl

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -23,7 +23,7 @@ catch_dollar(ex::Expr) =
2323
"""
2424
@formula(ex)
2525
26-
Capture and parse a formula expression as a `Formula` struct.
26+
Capture and parse a formula expression as a `FormulaTerm` struct.
2727
2828
A formula is an abstract specification of a dependence between _left-hand_ and
2929
_right-hand_ side variables as in, e.g., a regression model. Each side
@@ -32,7 +32,7 @@ matrix suitable for modeling. This specification looks something like Julia
3232
code, is represented as a Julia `Expr`, but uses special syntax. The `@formula`
3333
macro takes an expression like `y ~ 1 + a*b`, transforms it according to the
3434
formula syntax rules into a lowered form (like `y ~ 1 + a + b + a&b`), and
35-
constructs a `Formula` struct which captures the original expression, the
35+
constructs a `FormulaTerm` struct which captures the original expression, the
3636
lowered expression, and the left- and right-hand-side.
3737
3838
Operators that have special interpretations in this syntax are

0 commit comments

Comments
 (0)