_pkgdown.yml

url: https://wviechtb.github.io/metafor/

template:
  package: preferably
  #bootstrap: 5
  params:
    #bootswatch: cosmo
    toggle: manual
    docsearch:
      api_key: b56f56470243cf9799f796a3d6ecaedd
      index_name: metafor
      app_id: SFWCWKDGL8
  opengraph:
    #image:
    #  src: man/figures/card.png
    #  alt: "Alternative text describing the image"
    twitter:
      creator: "@wviechtb"
      card: summary_large_image

code:
  width: 102

home:
  links:
  # - text: GitHub Repo
    # href: https://github.com/wviechtb/metafor
  - text: Package Website
    href: https://www.metafor-project.org
  - text: Author Website
    href: https://www.wvbauer.com

figures:
  dev: grDevices::png
  dpi: 192
  dev.args: []
  fig.ext: png
  fig.width: 9
  fig.height: 8
  fig.retina: 2
  fig.asp: ~

#figures:
#  dev: ragg::agg_png
#  dpi: 96
#  dev.args: []
#  fig.ext: png
#  fig.width: 9
#  fig.height: 8
#  fig.retina: 2
#  fig.asp: 1

navbar:
  title: "metafor"
  left:
    - icon: fa-home fa-lg
      href: index.html
    - text: Intro
      href: reference/metafor-package.html
    - text: "Functions"
      href: reference/index.html
    - text: "Diagram"
      href: articles/pkgdown/diagram.html
    - text: "JSS Article"
      href: https://www.jstatsoft.org/article/view/v036i03
    - text: "Changelog"
      href: news/index.html
  right:
   #- icon: fa-twitter
   #  href: https://twitter.com/wviechtb
   #- icon: fa-github
   #  href: https://github.com/wviechtb/metafor
   # this doesn't work :( so using text links for now
   #- icon: fa-mastodon
   #  href: https://scholar.social/@wviechtb
   - text: Mastodon
     href: https://scholar.social/@wviechtb
   - text: GitHub
     href: https://github.com/wviechtb/metafor

reference:
  - title: "Package Introduction"
    desc: >
      Introduction to the package.
    contents:
    - metafor-package
  - title: "Effect Sizes / Outcome Measures / Data Prep"
    desc: >
      Functions to compute various types of effect sizes / outcome measures and for data preparation.
    contents:
      - escalc
      - rcalc
      - vcalc
      - conv.wald
      - conv.delta
      - conv.fivenum
      - conv.2x2
  - title: "Model Fitting"
    desc: >
      Main model fitting functions.
    contents:
      - rma.uni
      - rma.mh
      - rma.peto
      - rma.glmm
      - rma.mv
  - title: "Plots / Figures"
    desc: >
      Functions for creating various types of plots and figures.
    contents:
      - funnel
      - forest
      - forest.default
      - forest.rma
      - forest.cumul.rma
      - addpoly
      - addpoly.default
      - addpoly.rma
      - addpoly.predict.rma
      - regplot
      - baujat
      - labbe
      - radial
      - llplot
      - gosh
      - plot.gosh.rma
      - plot.permutest.rma.uni
      - plot.rma
      - plot.cumul.rma
      - plot.infl.rma.uni
      - plot.profile.rma
      - plot.rma.uni.selmodel
      - plot.vif.rma
      - qqnorm.rma
  - title: "Publication Bias"
    desc: >
      Functions for detecting, assessing the impact of, and correcting for publication bias (funnel plot asymmetry / small-study effects).
    contents:
      - regtest
      - ranktest
      - trimfill
      - selmodel
      - hc
      - fsn
      - tes
  - title: "Inference Methods"
    desc: >
      Functions for drawing inferences based on meta-analytic models and for assessing the model fit.
    contents:
      - anova.rma
      - confint.rma
      - permutest
      - robust
      - cumul
      - fitted.rma
      - predict.rma
      - ranef
      - blup
      - fitstats
      - simulate.rma
      - update.rma
  - title: "Model Diagnostics"
    desc: >
      Functions for identifying outliers / influential studies, sensitivity analyses, and checking for multicollinearity.
    contents:
      - residuals.rma
      - influence.rma.uni
      - influence.rma.mv
      - weights.rma
      - leave1out
      - vif
  - title: "Print Methods"
    desc: >
      Print methods.
    contents:
      - print.rma
      - print.escalc
      - print.anova.rma
      - print.confint.rma
      - print.fsn
      - print.gosh.rma
      - print.hc.rma.uni
      - print.list.rma
      - print.permutest.rma.uni
      - print.ranktest
      - print.regtest
      - print.matreg
      - print.deltamethod
  # - title: "Datasets"
  #   desc: >
  #     Datasets included with the package.
  #   contents:
  #     - starts_with("dat")
  - title: "Extractor Functions"
    desc: >
      Functions to extract various elements from model objects.
    contents:
      - coef.rma
      - coef.permutest.rma.uni
      - vcov.rma
      - se.rma
      - model.matrix.rma
      - formula.rma
      - coef.matreg
      - vcov.matreg
      - coef.deltamethod
      - vcov.deltamethod
  - title: "Convenience Functions"
    desc: >
      Miscellaneous convenience functions.
    contents:
      - mfopt
      - bldiag
      - blsplit
      - dfround
      - replmiss
      - to.long
      - to.wide
      - to.table
      - contrmat
      - reporter
      - matreg
      - vec2mat
      - deltamethod
      - aggregate.escalc
      - metafor.news
      - transf
      - formatters
      - emmprep
      - pairmat
  - title: "Other Methods"
    desc: >
      Other method functions.
    contents:
      - methods.escalc
      - methods.list.rma
      - methods.confint.rma
      - methods.anova.rma
      - methods.vif.rma
  - title: "Miscellaneous Documentation"
    desc: >
      Miscellaneous documentation on models, recommendations, and options.
    contents:
      - misc-models
      - misc-recs
      - misc-options