В Sat, 6 Apr 2024 18:27:24 +0000 "Ruff, Sergej" <sergej.r...@tiho-hannover.de> пишет:
> The CRAN site > (https://cran.r-project.org/web/packages/RepeatedHighDim/index.html) > has a "documentation" part with the refrence pdf. > > Can I link to our tutorial site (https://software.klausjung-lab.de/.) > under documentation? Since your tutorial is relatively short and contains R code intermixed with the results of running it, it could make a great vignette. Vignettes are linked on the CRAN page for a package right under the PDF reference manual. For example, the BiocManager package has one vignette: https://cran.r-project.org/package=BiocManager Vignettes are a part of the package and their code is automatically checked together with your examples. For the users of your package, this will help keep the tutorial available (even if the website moves in the future) and compatible with the current version of the package (even if the package evolves and the tutorial website evolves together with it). R has built-in support for PDF vignettes via LaTeX using Sweave [*]. HTML vignettes can be much more accessible than PDF files, but there is no built-in HTML vignette engine in R [**]. The 'markdown' package is reasonably lightweight and has an HTML vignette engine. Markdown tries to be a superset of HTML, so it should be possible to keep most of your original HTML, including the styling, while rewriting the tutorial as an executable vignette. -- Best regards, Ivan [*] https://cran.r-project.org/doc/manuals/R-exts.html#Writing-package-vignettes [**] It's possible to write a crude HTML vignette engine in ~100 lines of R code, but we cannot expect every package author to do that. ______________________________________________ R-package-devel@r-project.org mailing list https://stat.ethz.ch/mailman/listinfo/r-package-devel
