1. Сайт для пакета:

Почему ты решил сделать отдельно сайт для пакета, если у нас на сайте в документации по проекту есть раздел по пакету? Какие это дают преимущества?

Преимущества дают при создании сайта для пакета отдельно:

Все материалы пакета, необходимые для рендеринга веб-сайта будет автоматически генерируются:

    1. Документация (описание) (Rd.files) всех функций пакета автоматически генерируется в разделе reference сайта для пакета. По умолчанию, все функции будут включены и перечислены в алфавитном порядке (Но можем исправить их по группам: exploratory analysis tool, performance measurement,…) https://forvis.github.io/forvision/reference/index.html
    1. Любые Rmd файлы в подпапке vignettes автоматически генерируется в разделе articles сайта (мы можем написать любые виньетки, tutorials, статьи,.. и это автаматически генерируется в разделе articles) https://forvis.github.io/forvision/articles/

… ещё много и всё автоматически после одной команды: build_site()

а если хотим добавить все это на сайте проекта то придется сделать вручную всё : создание Rmd files -> преобразовать в Md file -> html files а потом добавить эти files вручную на сайте

Примеры некоторых сайтов для пакетов:

  1. forecast package (Rob Hyndman): http://pkg.robjhyndman.com/forecast/

  2. pkgdown package (Hadley Wickham) : https://pkgdown.r-lib.org/index.html

  3. MODIStsp (Lorenzo Busetto): http://ropensci.github.io/MODIStsp/

На сайте в документации по проекту есть раздел по пакету: мы можем сделать гиперссылку для этого раздела и это ссылается на сайт пакета: fovis.github.io/forvison

Почему называется docs? Может тогда назвать R package?

После рендеринга веб-сайта для пакета все Все еобходимые материалы для сайта сохраняется в подпапке Docs поэтому я так назвал, мы можем назвать как хотим

2. Документация для пакета:

Все описания функций пакета в виде комемнтарий:

#' Prediction-Realization Diagram for the given data from dataset
#'
#' This function plots Prediction-Realization Diagram for the given
#' data from dataset for different methods.
#'
#' @aliases plotPRD
#' @param df A data frame containing columns "value", "forecast", and "method".
#' @param useLogs logical. If TRUE the resulting prediction-relization
#' digram plotted in logarithmic scales. If FALSE the resulting
#' prediction-relization diagram plotted in scales by default.
#' @param xlim The minimum and maximum values on the axis "Ox". If xlim is NULL, minimum and maximum values are calculated based on given data.
#' @param ylim The minimum and maximum values on the axis "APE"Oy". If ylim is NULL, minimum and maximum values are calculated based on given data.
#' @return \code{plotPRD} function plots Prediction-Realization Diagram for the given data
#' from dataset.
#' @author Sai Van Cuong, Andrey Davydenko and Maixm Shcherbakov
#' @seealso \code{\link{plotFS}}, \code{\link{plotFAN}}
#' @references Jacob A. Mincer and Victor Zarnowits  (1969) Volume title: "Economic Forecasts
#' and Expectations: Analysis of Forecasting Behavior and Performance".Chapter title: \emph{The
#' Evaluation of Economic Forecasts}. Chapter pages in book: (p.3-46).
#' \url{http://www.nber.org/chapters/c1214.pdf}.
#' @keywords dataframe
#' @examples
#' df <- createAFTS(tsts = example1_TSTS, fts = example1_FTS, na = FALSE)
#' plotPRD(df)
#'
#' @export

plotPRD <-function(df, useLogs = FALSE, xlim=NULL, ylim=NULL){
  ...
}

И после build пакета, все эти комментарии будут автоматически сгенерированы в виде документации (pdf) (описание, которое я Вам отправил)

И Вы можете исправить эти комментарии прямо на Гитхабе (я имею в виду английский язык)

пример документация пакета forecast: https://cran.r-project.org/web/packages/forecast/forecast.pdf

3. Appendix

включить в описание пакета описание форматов данных?

Если У нас есть Rmd.file (R Markdown document) то включить appendix туда без проблемы путем использования следующего синтаксиса:

---
output:
  html_document:
    includes:
      after_body: appendix.md
---

A проблема в том, что описание пакета (referene manual) это вообще мы не делаем вручную, нет ни какой Rmd.file

Это referene manual получается путем следующей командой:

 system("R CMD Rd2pdf name_of_package")

Эта функция собрирает все комментарии для функций пакета в кучу и в итоге получается referene manual в виде pdf. То есть ни где мы не можем редактировать для включения appendix в это referene manual.

Посмотрите, пожалуйста! Примеры некоторых referene manual известных пакетов:

https://cran.r-project.org/web/packages/forecast/forecast.pdf

https://cran.r-project.org/web/packages/ggplot2/ggplot2.pdf

У них тоже включены встроенные наборы данных в пакете. А описание для данных также сделали как и я:

Не надо мучиться с этим. где есть TSTS, FTS мы пишем:

Тут можем переименовать данные на TSTS напрмер

и это ссылается на описание данных example1_TSTS. Там есть пример и все ясно что такое TSTS