need a central example and a user story

[epogrebnyak]

Several ideas about README - I think both acceptance a and development can work faster if there is a central use case how thansition matrix should work.

As of now the documentation relies on the user already knows a lot and will be seeking how to do it with the package, and this requires a lot of exploration and trials with the library.

I imagine the main use of transition matrix is to generate next period portfolio structure by rating? Is it done in transition matrix package or elsewhere?

Can we point to from readme to specific package functions?

You can use transitionMatrix to

Estimate transition matrices from historical event data using a variety of estimators
Visualize event data and transition matrices
Manipulate transition matrices (generators, comparisons etc.)
Provide standardized data sets for testing
Model transitions using threshold processes
Map credit ratings using mapping tables between popularly used rating systems

A user might want to define a TM from historical data, create a generator to roll forward and obtain new portfolio, is this a central usecase and the rest of the questions are enhancements?

Maybe it is a deeper issue about what should be in readme / documentation and what goes into tutorials / course.

[Alken0]

Hey,

(some input from a user)
I am a new user and I want to generate the plots from the readme.
I have data and don't want to generate any new data.

It would be cool to just load the data and invoke a function 'plot overview' without needing to look at all the matrixes.

My goal is to get an overview over my data.

Problems:

• it took me some time until I knew how to preprocess (a simple linked example might be enough)
• I currently don't know how to generate the plots (without doing it by hand)