initial setup

.github/workflows/CompatHelper.yml

@@ -0,0 +1,16 @@
+name: CompatHelper
+on:
+  schedule:
+    - cron: 0 0 * * *
+  workflow_dispatch:
+jobs:
+  CompatHelper:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Pkg.add("CompatHelper")
+        run: julia -e 'using Pkg; Pkg.add("CompatHelper")'
+      - name: CompatHelper.main()
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          COMPATHELPER_PRIV: ${{ secrets.DOCUMENTER_KEY }}
+        run: julia -e 'using CompatHelper; CompatHelper.main()'

.github/workflows/TagBot.yml

@@ -0,0 +1,15 @@
+name: TagBot
+on:
+  issue_comment:
+    types:
+      - created
+  workflow_dispatch:
+jobs:
+  TagBot:
+    if: github.event_name == 'workflow_dispatch' || github.actor == 'JuliaTagBot'
+    runs-on: ubuntu-latest
+    steps:
+      - uses: JuliaRegistries/TagBot@v1
+        with:
+          token: ${{ secrets.GITHUB_TOKEN }}
+          ssh: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/ci.yml

@@ -0,0 +1,65 @@
+name: continuous-integration
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+on:
+  push:
+    branches:
+      - main
+    paths-ignore:
+      - 'LICENSE.md'
+      - 'README.md'
+  pull_request:
+    branches:
+      - main
+    paths-ignore:
+      - 'LICENSE.md'
+      - 'README.md'
+jobs:
+  ci:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        version: [1.6, 1]
+        arch: [x64]
+        os: [ubuntu-latest]
+    steps:
+      - name: Checkout
+        uses: actions/checkout@v2
+      - name: Julia Setup
+        uses: julia-actions/setup-julia@v1
+        with:
+          version: ${{ matrix.version }}
+          arch: ${{ matrix.arch }}
+      - uses: julia-actions/cache@v1
+        with:
+            cache-compiled: "true"
+      - name: Build
+        uses: julia-actions/julia-buildpkg@v1
+      - name: Test
+        uses: julia-actions/julia-runtest@v1
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+      - name: Coverage Process
+        uses: julia-actions/julia-processcoverage@v1
+        if:  ${{ startsWith(matrix.os, 'ubuntu') && (matrix.version == '1') }}
+      - name: Coverage Upload
+        uses: codecov/codecov-action@v2
+        if:  ${{ startsWith(matrix.os, 'ubuntu') && (matrix.version == '1') }}
+        with:
+          file: lcov.info
+      - name: Setup Node for Percy
+        if: ${{ matrix.version == '1' }}
+        uses: actions/setup-node@v3
+        with:
+          node-version: '14'
+      - name: Install Percy CI
+        if: ${{ matrix.version == '1' }}
+        run: npm install --save-dev @percy/cli
+      - name: Percy Upload
+        if: ${{ matrix.version == '1' }}
+        run: |
+          ls ./test/out/ # useful for debugging
+          npx percy upload ./test/out
+        env:
+          PERCY_TOKEN: ${{ secrets.PERCY_TOKEN }}

.github/workflows/docs-cleanup.yml

@@ -0,0 +1,26 @@
+# remove PR previews once they're merged
+# <https://juliadocs.github.io/Documenter.jl/dev/man/hosting/#gh-pages-Branch>
+name: Doc Preview Cleanup
+on:
+  pull_request:
+    types: [closed]
+jobs:
+  doc-preview-cleanup:
+    runs-on: ubuntu-latest
+    steps:
+      - name: Checkout gh-pages branch
+        uses: actions/checkout@v2
+        with:
+          ref: gh-pages
+      - name: Delete preview and history + push changes
+        run: |
+            if [ -d "previews/PR$PRNUM" ]; then
+              git config user.name "Documenter.jl"
+              git config user.email "[email protected]"
+              git rm -rf "previews/PR$PRNUM"
+              git commit -m "delete preview"
+              git branch gh-pages-new $(echo "delete history" | git commit-tree HEAD^{tree})
+              git push --force origin gh-pages-new:gh-pages
+            fi
+        env:
+            PRNUM: ${{ github.event.number }}

.github/workflows/documenter.yml

@@ -0,0 +1,25 @@
+name: Documenter
+concurrency:
+  group: ${{ github.workflow }}-${{ github.head_ref || github.run_id }}
+  cancel-in-progress: true
+on:
+  push:
+    branches: [main]
+    tags: [v*]
+  pull_request:
+    branches:
+      - main
+jobs:
+  Documenter:
+    name: Documentation
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v2
+      - uses: julia-actions/cache@v1
+        with:
+          cache-compiled: "true"
+      - uses: julia-actions/julia-buildpkg@latest
+      - uses: julia-actions/julia-docdeploy@latest
+        env:
+          GITHUB_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+          DOCUMENTER_KEY: ${{ secrets.DOCUMENTER_KEY }}

.github/workflows/style.yml

@@ -0,0 +1,38 @@
+name: Style-Enforcer
+on:
+  push:
+    branches:
+      - 'main'
+    tags: '*'
+  pull_request:
+    types: [opened, synchronize, reopened, ready_for_review]
+    # note: keep in sync with `format/run.jl`
+    paths-ignore:
+      - 'README.md'
+      - '.gitignore'
+jobs:
+  format-check:
+    name: Style Enforcement (Julia ${{ matrix.julia-version }} - ${{ github.event_name }})
+    # Run on push's or non-draft PRs
+    if: (github.event_name == 'push') || (github.event.pull_request.draft == false)
+    runs-on: ubuntu-latest
+    strategy:
+      matrix:
+        julia-version: [1.6]
+    steps:
+      - uses: julia-actions/setup-julia@latest
+        with:
+          version: ${{ matrix.julia-version }}
+      - uses: actions/checkout@v1
+      - name: Instantiate `format` environment and format
+        run: |
+          julia -e'
+          using Pkg; Pkg.activate()
+          Pkg.add("JuliaFormatter")
+          using JuliaFormatter
+          format(".", YASStyle())'
+      - uses: reviewdog/action-suggester@v1
+        if: github.event_name == 'pull_request'
+        with:
+          tool_name: JuliaFormatter
+          fail_on_error: true

.gitignore

@@ -0,0 +1,28 @@
+# Files generated by invoking Julia with --code-coverage
+*.jl.cov
+*.jl.*.cov
+
+# Files generated by invoking Julia with --track-allocation
+*.jl.mem
+
+# System-specific files and directories generated by the BinaryProvider and BinDeps packages
+# They contain absolute paths specific to the host computer, and so should not be committed
+deps/deps.jl
+deps/build.log
+deps/downloads/
+deps/usr/
+deps/src/
+
+# Build artifacts for creating documentation generated by the Documenter package
+docs/build/
+docs/site/
+
+# File generated by Pkg, the package manager, based on a corresponding Project.toml
+# It records a fixed state of all packages used by the project. As such, it should not be
+# committed for packages, but should be committed for applications that require a static
+# environment.
+Manifest.toml
+
+# Editor files
+.vscode/*
+*~

Project.toml

@@ -0,0 +1,52 @@
+name = "BoxCox"
+uuid = "1248164d-f7a6-4bdb-8e8d-8c4a187b3ce6"
+authors = ["Phillip Alday <[email protected]>"]
+version = "0.1.0"
+
+[deps]
+Compat = "34da2185-b29b-5c13-b0c7-acf172513d20"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+LinearAlgebra = "37e2e46d-f89d-539d-b4ee-838fcccc9c8e"
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+NLopt = "76087f3c-5699-56af-9a33-bf431cd00edd"
+Printf = "de0858da-6303-5e67-8744-51eddeeeb8d7"
+Statistics = "10745b16-79ce-11e8-11f9-7d13ad32a3b2"
+StatsAPI = "82ae8749-77ed-4fe6-ae5f-f523153014b0"
+StatsBase = "2913bbd2-ae8a-5f71-8c99-4fb6c76f3a91"
+StatsFuns = "4c63d2b9-4356-54db-8cca-17b64c39e42c"
+StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
+
+[weakdeps]
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
+Tables = "bd369af6-aec1-5ad0-b16a-f7cc5008161c"
+
+[extensions]
+BoxCoxMakieExt = "Makie"
+BoxCoxStatsModelsExt = ["StatsModels", "Tables"]
+
+[compat]
+Aqua = "0.6"
+Compat = "3.29, 4"
+DocStringExtensions = "0.9"
+Makie = "0.19.0"
+NLopt = "0.6, 1"
+RDatasets = "0.7"
+StatsAPI = "1.6"
+StatsBase = "0.33, 0.34"
+StatsFuns = "1"
+StatsModels = "0.6, 0.7"
+Tables = "1"
+julia = "1.6"
+
+[extras]
+Aqua = "4c88cf16-eb10-579e-8560-4a9242c79595"
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+Makie = "ee78f7c6-11fb-53f2-987a-cfe4a2b5a57a"
+RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
+StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
+Test = "8dfed614-e22c-5e08-85e1-65c5234f0b40"
+
+[targets]
+test = ["Aqua", "CairoMakie", "StatsModels", "RDatasets", "Test"]

README.md

@@ -1 +1,15 @@
-# BoxCox.jl
+# BoxCox.jl
+
+[![Project Status: WIP – Initial development is in progress, but there has not yet been a stable, usable release suitable for the public.](https://www.repostatus.org/badges/latest/wip.svg)](https://www.repostatus.org/#wip)
+[![Stable Docs][docs-stable-img]][docs-stable-url]
+[![Dev Docs][docs-dev-img]][docs-dev-url]
+[![Codecov](https://codecov.io/gh/palday/BoxCox.jl/branch/main/graph/badge.svg)](https://codecov.io/gh/palday/BoxCox.jl)
+<!-- [![DOI](https://zenodo.org/badge/337082315.svg)](https://zenodo.org/badge/latestdoi/337082315) -->
+[![Code Style: YAS](https://img.shields.io/badge/code%20style-yas-1fdcb3.svg)](https://github.com/jrevels/YASGuide)
+[![This project is using Percy.io for visual regression testing.](https://percy.io/static/images/percy-badge.svg)](https://percy.io/d68e1e2f/BoxCox.jl)
+
+[docs-dev-img]: https://img.shields.io/badge/docs-dev-blue.svg
+[docs-dev-url]: https://palday.github.io/BoxCox.jl/dev
+
+[docs-stable-img]: https://img.shields.io/badge/docs-stable-blue.svg
+[docs-stable-url]: https://palday.github.io/BoxCox.jl/stable

docs/Project.toml

@@ -0,0 +1,10 @@
+[deps]
+CairoMakie = "13f3f980-e62b-5c42-98c6-ff1f3baf88f0"
+DocStringExtensions = "ffbed154-4ef7-542d-bbb7-c09d3a79fcae"
+Documenter = "e30172f5-a6a5-5a46-863b-614d45cd2de4"
+RDatasets = "ce6b1742-4840-55fa-b093-852dadbb1d8b"
+Random = "9a3f8284-a2c9-5f02-9a11-845980a1fd5c"
+StatsModels = "3eaba693-59b7-5ba5-a881-562e759f1c8d"
+
+[compat]
+Documenter = "0.27"

docs/make.jl

@@ -0,0 +1,10 @@
+using Documenter
+using DocStringExtensions
+using BoxCox
+
+makedocs(; root=joinpath(dirname(pathof(BoxCox)), "..", "docs"),
+         sitename="BoxCox",
+         doctest=true,
+         pages=["index.md", "api.md"])
+
+deploydocs(; repo="github.com/palday/BoxCox.jl", push_preview=true, devbranch="main")

docs/src/api.md

@@ -0,0 +1,17 @@
+```@meta
+CurrentModule = BoxCox
+DocTestSetup = quote
+    using BoxCox
+end
+DocTestFilters = [r"([a-z]*) => \1", r"getfield\(.*##[0-9]+#[0-9]+"]
+```
+
+# API
+
+```@index
+```
+
+```@autodocs
+Modules = [BoxCox]
+Private = false
+```