search

zedtaha / nardl

nardl:An R package to estimate the nonlinear cointegrating autoregressive distributed lag model
14 stars 9 forks source link

Help files nardl and summary.nardl incomplete #8

Open JoFAM opened 6 years ago

JoFAM commented 6 years ago

Help file nardl needs a basic description and a return value at least.

Help file summary.nardl doesn't exist, but it is an exported function.

JoFAM commented 6 years ago

@zedtaha the help files nardl and summary.nardl aren't complete.

In summary.nardl the value components are not listed.

I've addded the items already for the function nardl in commit ef35700

JoFAM commented 6 years ago

summary.nardl now has a components list in commit b80d17d

@zedtaha you can use that one as an example of what the help page of the nardl package needs. As nardl() is your main function, that's one thing you really should document extensively. Otherwise nobody knows where to get what information to eg use your pkg in simulations etc.