Вопросы по теме 'roxygen2'
Документирование классов/методов R.oo с помощью Roxygen
Может ли кто-нибудь указать мне на хороший пример документирования классов/методов R.oo с помощью Roxygen? В R.oo классы/методы создаются вызовами setConstructorS3() и setMethodS3(), поэтому нет функции для документирования как таковой. Вы просто...
312 просмотров
schedule
17.08.2022
Ссылки на статьи в пакете R с использованием roxygen2 и BibTeX?
Я использую roxygen2 в качестве инструмента для документирования моего пакета R, и я обнаружил, что в roxygen2 есть тег @references, но, похоже, он принимает только текст в произвольной форме. Я нашел презентацию о roxygen с тегами @bibliograph и...
3575 просмотров
schedule
29.04.2022
Как не запускать пример с помощью roxygen2?
Сейчас я пишу функцию геокодирования , которая зависит при наличии ключа Bing Maps. Очевидно, я бы предпочел не публиковать свой, а примеры не работают без него.
Как включить пример, чтобы пользователи запускали его вручную, но не выполняли во...
23746 просмотров
schedule
29.11.2022
как я могу добавить roxygen @export все функции в пакет
Я принимаю существующий пакет. Пакет был написан с документацией .Rd до того, как R потребовал явного экспорта функций.
Моим первым шагом было преобразование документации в roxygen с помощью Rd2roxygen (большое спасибо Yihui и Hadley за этот...
1748 просмотров
schedule
10.04.2022
Использование тегов шаблона Roxygen2
Может ли кто-нибудь привести пример того, как правильно использовать теги шаблона в Roxygen2 . Я попытался сделать самое очевидное (для меня):
В моем файле packageName-package.R :
#' [... other Roxygen blocks ...]
#'
#' @templateVar...
2994 просмотров
schedule
15.04.2022
Импорт двух функций с одинаковым именем с помощью roxygen2
Я сопровождаю пакет CRAN и получаю следующие сообщения при загрузке:
* checking whether package ‘qdap’ can be installed ... [10s/10s] WARNING
Found the following significant warnings:
Warning: replacing previous import ‘annotate’ when loading...
5401 просмотров
schedule
09.08.2022
Документирование эталонного класса с помощью roxygen2 R CMD проверяет предупреждение о несоответствии кодока
Я пытаюсь использовать roxygen2 для создания документации для объекта эталонного класса, но я продолжаю получать это предупреждение, когда запускаю проверку R CMD:
S4 class codoc mismatches from documentation object 'myRefClass-class':
Slots...
1537 просмотров
schedule
18.02.2022
Как я должен ссылаться на функции в импортированных пакетах?
При создании пакета R существует как минимум два варианта ссылки на функции в импортированных пакетах.
Либо,
Явно называйте функцию, используя оператор с двойным двоеточием всякий раз, когда вы ее вызываете, package::function .
Добавьте...
571 просмотров
schedule
26.08.2022
Ссылка на страницу документации без функции в R с использованием roxygen2
Мне интересно, есть ли возможность при написании пакета в R ссылаться на страницу документации в R, которая не имеет включенных функций, но имеет только информацию о пакете? Например \link[stats]{stats-package.R} ?
415 просмотров
schedule
30.06.2022
Расположение файлов при использовании тега @example с roxygen2
При документировании функции с помощью roxygen2 можно поместить примеры в отдельный файл.
См. здесь: http://r-pkgs.had.co.nz/man.html «Вместо того, чтобы включать примеры непосредственно в документацию, вы можете поместить их в отдельные файлы и...
583 просмотров
schedule
16.02.2023
Есть ли способ задокументировать несколько наборов данных в одном файле R при компиляции документации с пакетом roxygen2 в R?
Мне интересно, есть ли возможность иметь 1 страницу справки в документации в R для более чем 1 набора данных? И мне интересно, возможно ли @alias в таком случае?
Более или менее я хотел бы задокументировать 3 таких набора данных
#'
#'...
130 просмотров
schedule
23.06.2022
Как получить прямой доступ к методу S3 в пакете roxygen2 R
Я пишу свой первый пакет с помощью roxygen2 . Пакет реализует более быструю версию pcdtest() из пакета plm . Таким образом, я вызываю в своем пакете:
merr <- resid(mod)
Пакет plm реализует метод S3 для resid. Он экспортирует его в...
190 просмотров
schedule
10.06.2023
Документация Roxygen2 в вязальщике
Предположим, что файл knitr (rnw) с фрагментом кода
<<function, include=FALSE>>=
#' A simple function
#'
#' @param foo Variable foo.
#' @param bar Variable bar.
#'
#' @return The product of foo and bar
product<-function(foo, bar)...
279 просмотров
schedule
14.11.2022
Примечание CRAN при использовании шаблона roxygen2
Я использую шаблон rogyxen2 в своем пакете R. Как и было предложено, я добавил R-файлы своего шаблона в папку с именем «man-roxygen» в каталоге пакета.
Однако, когда я проверяю CMD, я получаю следующее примечание:
На верхнем уровне...
380 просмотров
schedule
12.04.2022
Написание метода as.data.frame для пользовательских объектов S3
Во многих вариантах подобные вопросы задавались много раз... но не нахожу внятного совета по поводу:
"экспорт методов S3 как функций"
Я написал собственный класс S3 с помощью roxygen2 , назовите его 'my_item' . Это функция...
907 просмотров
schedule
26.12.2022
Строки документации roxygen2 для ссылочных классов, переопределяющих базовый класс
У меня есть абстрактный базовый класс, который выглядит так:
#' An Abstract Base Class
Filter <- setRefClass(
Class = "Filter",
methods = list(
train = function(x) {
"Override this method to train any associated parameters for...
139 просмотров
schedule
24.10.2022
Как вставить пробел в текст в файле .PDF, созданном с помощью .R -> (roxygen2) .Rd -> (R CMD check mypackage) .PDF?
Я уже создал много файлов .PDF через «.R» -> (roxygen2) «.Rd» -> (R CMD check mypackage) «.PDF».
Теперь я хотел добавить шаблон таблицы в файл .PDF пакета (mypackage-manual.pdf):
Table: ADF Statistics of the Raw Variables...
174 просмотров
schedule
09.06.2022
Экспорт списка функций с помощью roxygen2
Проблема : я хочу экспортировать список функций как часть пакета R, в идеале с помощью roxygen2.
Точнее, я хочу экспортировать функции в списке, а не сам список. Например, рассмотрим список функций, которые генерируются как замыкания, например:...
802 просмотров
schedule
26.09.2022
roxygen2 не создает документацию .Rd
Я не могу создать файлы документации .Rd для своего пакета с помощью RStudio и Roxygen2. Во-первых, позвольте мне упомянуть, что я столкнулся с похожими проблемами, опубликованными здесь, и уже сделал следующее:
Блоки Roxygen2 инициируются в...
1214 просмотров
schedule
31.08.2022
Класс S4 с перегрузкой конструктора имеет дубликаты в документации roxygen2.
Я написал класс S4 в пакете R. Я использую roxygen2 для документации:
#' A timeframe class represents a start date, end date and frequency
#'
#' @slot start_date First date in the timespan
#' @slot end_date Last date in the timespan
#' @slot...
92 просмотров
schedule
04.07.2022
