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                                              29.0                      13.0
#> mean revision                                  -0.1                      -0.3
#> st.dev.                                         2.6                       1.1
#> min                                            -5.5                      -2.9
#> q.10                                           -3.4                      -1.3
#> median                                         -0.4                      -0.3
#> q.90                                            3.7                       1.0
#> max                                             4.9                       1.2
#> % positive                                      0.4                       0.3
#> % zero                                          0.0                       0.0
#> % negative                                      0.6                       0.7
#> mean absolute revision                          2.0                       0.9
#> root mean square revision                       2.6                       1.1
#>                           [Release[4]]-[Release[3]] [Release[5]]-[Release[4]]
#> N                                               6.0                       4.0
#> mean revision                                   0.0                       0.1
#> st.dev.                                         0.8                       0.2
#> min                                            -0.9                      -0.1
#> q.10                                           -0.9                      -0.1
#> median                                          0.2                       0.0
#> q.90                                            0.8                       0.2
#> max                                             1.0                       0.3
#> % positive                                      0.7                       0.5
#> % zero                                          0.0                       0.0
#> % negative                                      0.3                       0.5
#> mean absolute revision                          0.6                       0.1
#> root mean square revision                       0.7                       0.1