Я документирую функцию пакета, используя roxygen
.Один аргумент dataset
поясняется кратким описанием в функции, например
@params dataset is a dataframe to be processed.
Однако, чтобы лучше понять, что такое dataset
, я хочу перенаправить пользователя к документации example_dataset
задокументировано в data.R
скрипте моего пакета.
Для обычных функций я могу сделать это \link{other_function}
.Однако для набора данных, по-видимому, \link{"example_dataset"}
не работает из коробки:
help(my_function)
и переход по ссылке на example_dataset
приводит к сообщению:
No help found for topic "example_sample_annotation" in any package.
Можно ли связать страницу справки my_function
с example_dataset
?