Vignettes

[kgoldfeld]

Vignettes

[assignUser]

I checked the vignette using the R-CMD-Manual action like this:

And found some issues: I seem to have accidentally removed the suggest for formatR which made the build fail because it is used to style the code by knitr. Additionally you used data.table without library(data.table) which worked on your end due to having it loaded by devtools.

After those changes it worked well. I will add an action to automatically build vignettes when they have been changed :)

The new vignette looks great!

[kgoldfeld]

I uploaded the remaining vignettes (in the vignette branch). I haven't really edited the the older files - I definitely need to edit the ordinal data vignette to reflect what is likely to be the new unified function. This will give me a good opportunity to check that.

I don't fully understand how the vignettes get incorporated into the package. On my local build, I seem to have hit or miss success building and installing with the new vignettes.

[assignUser]

All of the vignettes build now except for the ordinal.Rmd one. There you use a functions called odds() do you remember which package that is from?

Vignettes are rendered when the package is build/packaged into a zip and live in the inst/doc folder. (and they are part of the pgkdown site) I think on cran they don't build the vignettes only running the related r code.

A main issue with building vignettes is (on rhub & github actions) that you need to declare alle packages you use in them in suggests, otherwise the packages wont be installed and the vignette will fail. (which was the case here wit gee and ordinal)

[kgoldfeld]

I have my own personal package called ksgMisc which has a number of useful, simple functions. The odds function is the simplest (though I should probably check to make sure that 0 <= p < 1:

odds <- function (p)  p/(1 - p) 

I guess we could create that function in simstudy - and could make it public or not.

[assignUser]

I updated the vignette branch and everything compiles without issues! I also locally build the pgkdown site with the new vignettes and documentation and it looks great. Do we want to update the README or do we want to keep it simple as it is now?

The only thing I would change is the vignette titles:

I think removing "simstudy:" and converting to title case will look a bit smoother.

[kgoldfeld]

Maybe we can put the first part of the new intro vignette into the README, up until More Details ...

I agree with you on the vignette titles ...

[assignUser]

Yeah that looks good now:

I think the README is fine with the short intro, the overview vignette shows up as "Get Started" so that fits well.
Once I take care of #41 and #46 should we create a dedicated double-dot vignette to show off the advantages of this new feature?

[kgoldfeld]

Looks good. We could definitely do that - expanding on what is described in the overview. I had another idea for a useful function, particularly if you implment the vectorization. It could be nice to have a function genMixFormula(functions, probs) that takes two arguments - a vector of function names or a double-dot variable that is itself a vector and a vector of probabilities (which could be NULL, defaulting to equal probability 1/n with n functions being mixed.

Just something for one of us to think about in the future.

[assignUser]

I created an issue so we do not loose track of these ideas 👍