Skip to contents

Descriptive statistics

Usage

descriptive_statistics(revisions.view, rounding = 3)

Arguments

revisions.view

mts object. Vertical or diagonal view of the get_revisions() output

rounding

number of decimals to display

Examples


## Simulated data
df_long <- simulate_long(
    n_period = 10L * 4L,
    n_revision = 5L,
    periodicity = 4L,
    start_period = as.Date("2010-01-01")
)

## Create vintage and get descriptive statistics of revisions
vintages <- create_vintages(df_long, periodicity = 4)
revisions <- get_revisions(vintages, gap = 1)
descriptive_statistics(revisions[["diagonal_view"]], rounding = 1)
#>                           [Release[2]]-[Release[1]] [Release[3]]-[Release[2]]
#> N                                              35.0                      25.0
#> mean revision                                  -0.5                       0.0
#> st.dev.                                         2.1                       1.1
#> min                                            -3.6                      -2.4
#> q.10                                           -3.2                      -1.2
#> median                                         -0.4                       0.0
#> q.90                                            1.7                       1.3
#> max                                             4.2                       2.1
#> % positive                                      0.5                       0.5
#> % zero                                          0.0                       0.0
#> % negative                                      0.5                       0.5
#> mean absolute revision                          1.8                       0.9
#> root mean square revision                       2.1                       1.1
#>                           [Release[4]]-[Release[3]] [Release[5]]-[Release[4]]
#> N                                              10.0                       5.0
#> mean revision                                  -0.1                      -0.1
#> st.dev.                                         0.6                       0.3
#> min                                            -1.4                      -0.6
#> q.10                                           -0.6                      -0.4
#> median                                         -0.1                       0.0
#> q.90                                            0.4                       0.2
#> max                                             0.9                       0.3
#> % positive                                      0.3                       0.6
#> % zero                                          0.0                       0.0
#> % negative                                      0.7                       0.4
#> mean absolute revision                          0.4                       0.2
#> root mean square revision                       0.6                       0.3