cmdstanr/_pkgdown.yml at master · stan-dev/cmdstanr · GitHub

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
url: https://mc-stan.org/cmdstanr

development:
  mode: auto

template:
  package: pkgdownconfig

toc:
  depth: 4

articles:
  - title: "Getting started"
    desc: >
      Installing CmdStan, fitting models, and accessing results.
    contents:
      - cmdstanr
  - title: "More details"
    desc: >
      More information about compilation, passing in data,
      how CmdStan ouput is written to CSV and read back into R,
      profiling Stan programs, running Stan on GPUs,
      and using CmdStanR in R Markdown documents.
    contents:
      - cmdstanr-internals
      - posterior
      - r-markdown
      - profiling
      - articles-online-only/opencl

reference:
  - title: "Package overview and global options"
    desc: >
      An overview of the package and how it differs from
      [RStan](https://mc-stan.org/rstan).
    contents:
      - cmdstanr-package
      - cmdstanr_global_options
  - title: "Installing and setting the path to CmdStan"
    desc: >
      Install CmdStan, assuming the necessary C++ toolchain.
    contents:
      - install_cmdstan
      - cmdstan_path
  - title: "Running CmdStan from R"
    desc: >
      Run CmdStan from R.
    contents:
      - cmdstan_model
      - CmdStanModel
      - starts_with("model-method")
      - cmdstanr_example
  - title: "Fitted model objects and methods"
    contents:
      - CmdStanMCMC
      - CmdStanMLE
      - CmdStanLaplace
      - CmdStanVB
      - CmdStanPathfinder
      - CmdStanGQ
      - CmdStanDiagnose
      - starts_with("fit-method")
  - title: "Other tools"
    contents:
      - read_cmdstan_csv
      - write_stan_json
      - write_stan_file
      - print_stan_file
      - draws_to_csv
      - as_mcmc.list
      - as_draws.CmdStanMCMC
      - cmdstan_coercion
  - title: "Using CmdStanR with knitr and R Markdown"
    contents:
      - register_knitr_engine
      - eng_cmdstan