Improve help files

[jandeneve]

Help file ?pim should be improved with several worked out examples and illustration of getters.

E.g. now it is difficult to find for the reader how to extract a p-value form a pim. Illustrate in examples how easy it is.

The help files on the datasets also have to be improved.

[JoFAM]

Files to do :

• [x] add.poset
• [x] as.data.frame
• [x] as.matrix
• [x] coef
• [x] confint.pim
• [x] create.poset
• [x] CreateScoreFun
• [x] DysData
• [x] EngelData
• [x] Estimators
• [x] Extract.pim.summary
• [x] FEVData
• [x] formula
• [x] Getters
• [x] Getters_pim.formula
• [x] Getters_pim
• [x] has.intercept
• [x] is.complete
• [x] LR
• [x] make.posfun
• [x] MHData
• [x] model.matrix.pim
• [x] new.pim.env
• [x] new.pim.formula
• [x] new.pim.poset
• [x] new.pim
• [x] nobs
• [x] P
• [x] penv
• [x] pim.environment-class
• [x] pim.fit
• [x] pim.formula class
• [x] pim.poset-class
• [x] pim
• [x] pim.summary-class
• [x] pim-class
• [x] pimdata (might just be removed actually)
• [x] pim-package
• [x] poset
• [x] print
• [x] response
• [x] sandwich.estimator
• [x] SUData
• [x] summary
• [x] vcov.estimators
• [x] vcov.internal
• [x] vcov
• [x] zzz (no help file, but still check!)

[JoFAM]

Help files are adapted in the branch "UpdateHelpFiles"

[JoFAM]

@jandeneve all help pages are done. Can you check ?pim to see if this is what you had in mind? The examples of the different models that were there already might need a bit more explanation as well, but I'm not sure whether they actually make sense. Input appreciated.