_pkgdown.yml

template:
  params:
    bootswatch: yeti
home:
  title: An R package for legislative redistricting
  description: >
    This R package enables researchers to sample redistricting plans from a
    pre-specified target distribution using Sequential Monte Carlo and Markov
    Chain Monte Carlo algorithms. The package supports various constraints in
    the redistricting process, such as geographic compactness and population
    parity requirements. Tools for analysis, including computation of various
    summary statistics and plotting functionality, are also included.
  links:
  - text: ALARM Project
    href: https://alarm-redist.github.io/
news:
 releases:
 - text: "redist 3.0"
   href: https://alarm-redist.github.io/posts/2021-04-02-redist-300/
 cran_dates: false
reference:
- title: "Simulation Algorithm Implementations"
  desc: "Core functions to perform a redistricting simulation"
- contents:
  - redist_smc
  - redist_mergesplit
  - redist_mergesplit_parallel
  - redist_flip
  - redist_shortburst
  - redist_constr
  - constraints
  - has_concept("simulate")
- title: "Analysis Functions"
  desc: "Functions for analyzing simulation outputs"
- contents:
  - redist_plans
  - summary.redist_plans
  - add_reference
  - subset_sampled
  - get_plans_matrix
  - get_plans_weights
  - number_by
  - pullback
  - match_numbers
  - tally_var
  - has_concept("analyze")
- title: "Setup Helpers"
  desc: "Functions that help prepare data and select constraints"
- contents:
  - redist_map
  - has_concept("prepare")
- title: "Plotting Tools"
  desc: "Functions for creating plots and maps"
- contents:
  - has_concept("plot")
- title: "Data"
  desc: "Data included to help demonstrate capabilities"
- contents:
  - has_concept("data")
- title: "Post Processing Helpers"
  desc: "Functions that help setup outputs for easier use"
- contents:
  - has_concept("post")
- title: "Enumeration Tools"
  desc: "Functions for more involved enumeration choices"
- contents:
  - has_concept("enumerate")
- title: "Miscellaneous"
  desc: "Other functions"
- contents:
  - redist-package
  - lacks_concepts(c("prepare", "simulate", "analyze", "plot", "enumerate", "data", "post"))