Feature request: documentation

Question

Feature request: documentation

jpiaskowski opened this issue 2 years ago · 13 comments

jpiaskowski commented 2 years ago

Is there any interest in launching a pkgdown site for this package? I am willing to implement this.

Answer 1 · 2022-05-31T21:43:51.000Z

That would be fine. I'll take an initial crack at this and hand it over to you if I run into trouble/give up.

Answer 2 · 2022-05-31T22:04:04.000Z

Excellent, thank you!

Answer 3 · 2022-05-31T22:32:36.000Z

I'm going to leave this open until it's done ...

Answer 4 · 2022-06-01T00:13:50.000Z

Partly working.

no GitHub actions machinery yet
vignette missing
README photo duplicated/maybe not working yet?

Answer 5 · 2022-06-01T06:04:00.000Z

I'm going to leave this open until it's done ...

Ah, sorry about that!

I can take a look at it tomorrow.

Answer 6 · 2022-06-01T20:54:57.000Z

I'm running into trouble with "glmmADMB" - it will not install (see failed run). Any idea what is going on with that?

Answer 7 · 2022-06-01T21:16:39.000Z

glmmADMB is only available via a drat repository (listed in the DESCRIPTION file).

This works for me locally:

install.packages("glmmADMB", repos = c(getOption("repos")["CRAN"], "https://bbolker.github.io/drat"))

(might need to add type = "source", hard-code the CRAN repo if it's not specified, etc.)

Does that give you enough info to add the machinery to GH actions?

Answer 8 · 2022-06-01T21:25:00.000Z

No that works locally, but it doesn't solve the gh action, but I think I found the solution.

Answer 9 · 2022-06-02T19:03:18.000Z

I solved the glmm ADMB issue (by telling the workflow to ignore it), but now having another mystery issue with the build. I've asked the Rstudio community for help

Answer 10 · 2022-06-02T19:05:01.000Z

No clue. I guess the v2 version of the actions is fairly new and may still have rough edges ... ?? Thanks for working on this ...

Answer 11 · 2022-06-03T14:37:53.000Z

I think this is the problem, which gives me some ideas on how to proceed.

Answer 12 · 2022-06-03T17:24:50.000Z

seems like pak is a little flaky these days ...

Answer 13 · 2022-06-14T04:59:43.000Z

I'm taking a bit of a break from this because the documentation is frustratingly slim and the help a bit terse. I'll come back to it (and maybe by then, the bug will be fixed). Nevertheless, thanks for the getting the documentation site up and running; it's helpful to be able to browse the functions so easily.