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                                              19.0                      18.0
#> mean revision                                  -0.2                       0.2
#> st.dev.                                         3.0                       0.9
#> min                                            -5.4                      -1.8
#> q.10                                           -4.8                      -0.9
#> median                                          0.6                       0.1
#> q.90                                            3.1                       1.4
#> max                                             4.3                       1.8
#> % positive                                      0.5                       0.6
#> % zero                                          0.0                       0.0
#> % negative                                      0.5                       0.4
#> mean absolute revision                          2.4                       0.7
#> root mean square revision                       2.9                       0.9
#>                           [Release[4]]-[Release[3]] [Release[5]]-[Release[4]]
#> N                                              15.0                       8.0
#> mean revision                                  -0.2                       0.1
#> st.dev.                                         0.6                       0.3
#> min                                            -1.4                      -0.2
#> q.10                                           -1.0                      -0.2
#> median                                         -0.1                       0.0
#> q.90                                            0.3                       0.4
#> max                                             0.5                       0.6
#> % positive                                      0.5                       0.4
#> % zero                                          0.0                       0.0
#> % negative                                      0.5                       0.6
#> mean absolute revision                          0.4                       0.2
#> root mean square revision                       0.6                       0.3