search

crsuzh / ReplicationSuccess

R package for Design and Analysis of Replication Studies
https://crsuzh.github.io/ReplicationSuccess/
1 stars 0 forks source link

pkgdown online documentation #47

Closed SamCH93 closed 3 years ago

SamCH93 commented 3 years ago

Has anybody experience with pkgdown? I have never used it but I guess it would provide an easy way to generate a nice online documentation.

florafauna commented 3 years ago

I also thought about pkgdown, but I have never tried it. - we could try it :)

CharlotteMicheloud commented 3 years ago

no need to do it before CRAN submission

florafauna commented 3 years ago

not high priority. but we would then probably change the 'url' in the DESCRIPTION file to that page url. So, it would be nice to have it before the CRAN submission. I tried it but the vignette is not shown on the page (small changes are needed) and it would be nice to build the page with a github action. I will try it with a new repository to not mess with this one.

florafauna commented 3 years ago

including Rnw (instead of Rmd) vignettes in the webpage seems to be tricky. I tried https://github.com/r-lib/pkgdown/issues/781 but it didn't work right away.

SamCH93 commented 3 years ago

Thanks for trying. Maybe we could try to migrate the vignette to Rmd at some point and for now don't include it on pkgdown? Is pkgdown otherwise working fine?

florafauna commented 3 years ago

jap, I'll make a pull request soon.

florafauna commented 3 years ago

https://github.com/florafauna/ReplicationSuccess/pull/65#issue-687664872