_pkgdown.yml

destination: docs

templates:
  params:
    bootswatch: lumen

navbar:
  title: "greed"
  type: inverse
  left:
    - icon: fa-home
    - text: "Home"
      href: index.html
    - text: "Reference"
      href: "reference/index.html"
    - text: "News"
      href: "news/index.html"
    - text: "Articles"
      menu:
      - text: "Gaussian Mixture Models"
        href: articles/GMM.html
      - text: "Latent Class Analysis"
        href: articles/LCA.html
      - text: "Mixture of Regressions"
        href: articles/MoR.html
      - text: "Graph clustering"
        href: articles/SBM.html
      - text: "Combined Models"
        href: articles/CombinedModels.html
      - text: "Mixture of Multinomials"
        href: articles/MoM.html
      - text: "Co-clustering and LBM"
        href: articles/LBM.html
  right:
    - icon: fa-github
    - text: github
      href: https://github.com/comeetie/greed

reference:
- title: 'Top-level fitting functions'
  desc: >
    Main clustering function
  contents:
    - '`greed`'
- title: 'Generic methods to explore a fit'
  desc: >
    Description of methods to extract coefficients and cut/plot a hierachical model fit.
  contents:
    - '`clustering,IclFit-method`'
    - '`ICL,IclFit-method`'
    - '`K,IclFit-method`'
    - '`prior,IclFit-method`'    
    - '`coef,IclFit-method`'
    - '`show,IclFit-method`'
    - '`cut,IclPath-method`'
    - '`plot,IclPath,missing-method`'
    - '`extractSubModel,CombinedModelsPath,character-method`'
    
- title: 'Fitting algorithms classes'
  desc: >
    Description of classes that describe the possible fitting algorithms.
  contents:
    - '`Alg-class`'
    - '`Hybrid-class`'
    - '`Multistarts-class`'
    - '`Genetic-class`'
    - '`Seed-class`'
- title: 'Supported generative models'
  desc: >
    Description of classes that corresponds to the different type of generative models that greed may use.
  contents:
    - '`Sbm-class`'
    - '`DcSbm-class`'
    - '`MultSbm-class`'
    - '`Lca-class`'
    - '`MoM-class`'
    - '`Gmm-class`'
    - '`DiagGmm-class`'
    - '`MoR-class`'
    - '`DcLbm-class`'
    - '`CombinedModels-class`'
    - '`DlvmPrior-class`'
    - '`DlvmCoPrior-class`'
- title: 'Models fit classes'
  desc: >
    Description of classes that describe a model fit.
  contents:
    - '`IclFit-class`'
    - '`IclPath-class`'
    - '`SbmFit-class`'
    - '`DcSbmFit-class`'
    - '`MultSbmFit-class`'
    - '`LcaFit-class`'
    - '`MoMFit-class`'
    - '`GmmFit-class`'
    - '`DiagGmmFit-class`'
    - '`MoRFit-class`'
    - '`DcLbmFit-class`'
    - '`CombinedModelsFit-class`'

- title: 'Hierarchical models fit classes'
  desc: >
    Description of classes that describe a hierachical model fit.
  contents:
    - '`SbmPath-class`'
    - '`DcSbmPath-class`'
    - '`MultSbmPath-class`'
    - '`LcaPath-class`'
    - '`MoMPath-class`'
    - '`GmmPath-class`'
    - '`DiagGmmPath-class`'
    - '`MoRPath-class`'
    - '`DcLbmPath-class`'
    - '`CombinedModelsPath-class`'
    
- title: 'Methods to explore a hierarchical fit'
  desc: >
    Description of methods to extract coefficients and cut/plot a hierachical model fit.
  contents:
    - '`gmmpairs`'
    - starts_with("coef")
    - starts_with("cut")
    - starts_with("plot")
    
- title: 'Misc tools'
  desc: >
    Miscaelenous utility functions.
  contents:
    - '`NMI`'
    - '`H`'
    - '`MI`'
    - '`spectral`'
    - '`to_multinomial`'
    - '`available_models`'
    - '`available_algorithms`'
    
- title: 'Data generation function'
  desc: >
    Functions to generate data from a specified generative model.
  contents:
    - '`rsbm`'
    - '`rdcsbm`'
    - '`rmultsbm`'
    - '`rmm`'
    - '`rmreg`'
    - '`rlbm`'
    - '`rlca`'

- title: Data sets
  desc: ~
  contents:
    - '`Books`'
    - '`Football`'
    - '`Jazz`'
    - '`fashion`'
    - '`mushroom`'
    - '`Fifa`'
    - '`Ndrangheta`'
    - '`Youngpeoplesurvey`'
    - '`NewGuinea`'
    - '`SevenGraders`'