ckm/_pkgdown.yml at main · InseeFrLab/ckm · 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://inseefrlab.github.io/ckm/
template:
  bootstrap: 5

navbar:
  structure:
    left:  [home, reference, articles, news]
    right: [search, github]

  components:
    reference:
      text: Package Contents
      href: reference/index.html
    news:
      text: News
      href: news/index.html
    github:
      icon: fa-github
      aria-label: GitHub
      text: Source Code
      href: https://github.com/inseefrlab/ckm

home:
  title: R package for applying the Cell Key Method

reference:
  - title: Generate individual keys in microdata
    desc:  A function to create the key associated with each individual
    contents:
      - build_individual_keys
  - title: Build a counting table and apply the CKM
    desc: |
      Functions to build and apply the Cell Key Method, on a single table or a list of tables.
    contents:
      - tabulate_cnt_micro_data
      - apply_ckm
      - tabulate_and_apply_ckm
      - tabulate_and_apply_ckm_list
  - title: Risk-utility trade-off
    desc: A set of functions to help choose the parameters
    contents:
      - assess_RU
      - assess_RUs
      - simulate_RUs
      - assess_risk
      - get_deviation_set
      - get_possibles_set
      - compute_frequencies
      - distance_hellinger
      - mean_absolute_deviation
      - mean_relative_absolute_deviation
  - title: Compute confidence intervals
    desc: |
      Functions providing confidence intervals for statistics built from perturbed counts.
    contents:
      - estimate_beta
      - estimate_beta_df
  - title: Build the transition matrix and prepare the perturbation table
    desc:  Functions to retrieve the transition matrix and compare scenarios by visualizing the theoretical noise distribution.
    contents:
      - create_transition_matrix
      - prepare_perturbation_table
      - test_matrices
      - visualize_distribution
  - title: Other functions
    contents:
      - build_parameters_table
      - convert_desc_table_to_list
      - distance_euclid
      - distance_manhattan
      - estimate_proba_precision_statistic
      - estimate_proba_precision_statistic_df
  - title: Example data
    desc: Example dataset to test the package functions
    contents:
      - dtest