Terms 2.0: son of Terms

.travis.yml

@@ -4,15 +4,23 @@ os:
   - linux
   - osx
 julia:
-  - 0.7
   - 1.0
+  - 1.1
   - nightly
+matrix:
+  allow_failures:
+    julia: nightly
 notifications:
   email: false
-
 after_success:
-  # push coverage results to Codecov and Coveralls
   - julia -e 'using Pkg; Pkg.add("Coverage"); using Coverage; Coveralls.submit(process_folder()); Codecov.submit(process_folder())'
-  # Update the documentation
-  - julia -e 'using Pkg; Pkg.add("Documenter")'
-  - julia -e 'using Pkg; include(joinpath("docs", "make.jl"))'
+jobs:
+  include:
+    - stage: "Documentation"
+      julia: 1.1
+      os: linux
+      script:
+        - julia --project=docs/ -e 'using Pkg; Pkg.develop(PackageSpec(path=pwd()));
+                                               Pkg.instantiate()'
+        - julia --project=docs/ docs/make.jl
+      after_success: skip

REQUIRE

@@ -1,3 +1,6 @@
-julia 0.7-beta
-DataFrames 0.15.0
+julia 1.0
+CategoricalArrays
+Tables
 StatsBase 0.22.0
+DataStructures
+Missings

appveyor.yml

@@ -1,7 +1,7 @@
 environment:
   matrix:
-  - julia_version: 0.7
   - julia_version: 1.0
+  - julia_version: 1.1
   - julia_version: nightly
 
 platform:

docs/Project.toml

@@ -0,0 +1,10 @@
+[deps]
+DataFrames = "a93c6f00-e57d-5684-b7b6-d8193f3e46c0"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+GLM = "38e38edf-8417-5370-95a0-9cbb8c7f171a"
+StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
+
+[compat]
+Documenter = "~0.21"

docs/make.jl

@@ -1,19 +1,16 @@
 using Documenter, StatsModels
 
 makedocs(
-    format = :html,
     sitename = "StatsModels.jl",
     pages = [
         "Introduction" => "index.md",
         "Modeling tabular data" => "formula.md",
-        "Contrast coding categorical variables" => "contrasts.md"
+        "Internals and extending the `@formula`" => "internals.md",
+        "Contrast coding categorical variables" => "contrasts.md",
+        "API documentation" => "api.md"
     ]
 )
 
 deploydocs(
-    julia = "0.6",
-    repo = "github.com/JuliaStats/StatsModels.jl.git",
-    target = "build",
-    deps = nothing,
-    make = nothing
+    repo = "github.com/JuliaStats/StatsModels.jl.git"
 )

docs/src/api.md

@@ -0,0 +1,93 @@
+```@meta
+CurrentModule = StatsModels
+DocTestSetup = quote 
+    using StatsModels, Random, StatsBase
+    Random.seed!(2001)
+end
+DocTestFilters = [r"([a-z]*) => \1", r"getfield\(.*##[0-9]+#[0-9]+"]
+```
+
+# StatsModels.jl API
+
+## Formulae and terms
+
+```@docs
+@formula
+term
+coefnames
+modelcols
+```
+
+### Higher-order terms
+
+```@docs
+FormulaTerm
+InteractionTerm
+FunctionTerm
+```
+
+### Placeholder terms
+
+```@docs
+Term
+ConstantTerm
+```
+
+### Concrete terms
+
+These are all generated by [`apply_schema`](@ref).
+
+```@docs
+ContinuousTerm
+CategoricalTerm
+InterceptTerm
+MatrixTerm
+collect_matrix_terms
+is_matrix_term
+```
+
+## Schema
+
+```@docs
+schema
+concrete_term
+apply_schema
+```
+
+## Modeling
+
+```@docs
+fit
+response
+modelmatrix
+```
+
+### Traits
+
+```@docs
+StatsModels.implicit_intercept
+StatsModels.drop_intercept
+```
+
+### Wrappers
+
+!!! warning
+
+    These are internal implementation details that are likely to change in the
+    near future.  In particular, the `ModelFrame` and `ModelMatrix` wrappers are
+    dispreferred in favor of using terms directly, and can in most cases be
+    replaced by something like 
+
+    ```julia
+    # instead of ModelMatrix(ModelFrame(f::FormulaTerm, data, model=MyModel))
+    sch = schema(f, data)
+    f = apply_schema(f, sch, MyModel)
+    response, predictors = modelcols(f, data)
+    ```
+
+```@docs
+ModelFrame
+ModelMatrix
+StatsModels.TableStatisticalModel
+StatsModels.TableRegressionModel
+```