Описание тега roxygen
Roxygen - это система документации в исходном коде для R.Она основана на Doxygen и является альтернативой созданию файлов.Rd, поскольку автоматически создает файлы.Rd пакета из документации в исходном коде.
1
ответ
Как `\ связать {}` с определенным разделом и файлом Rd с Roxygen2?
Скажем, я хочу сослаться на раздел "Подробности" моей документации для функции foo, что я делаю? \link{foo:Details} не похоже на работу, так что такое правильная команда?
05 фев '14 в 13:16
3
ответа
Есть ли способ автоматического обновления документации в пакете R?
Я использовал package.skeleton() для создания файлов справки.Rd несколько месяцев назад. Я отредактировал эти файлы, а также изменил функции, удалил некоторые функции, добавил другие. Есть ли функция, которая автоматизирует обновление файлов Rd? Обн…
04 ноя '10 в 18:30
1
ответ
Как устранить предупреждение Roxygen о "Имя не найдено..."?
Я вызываю roxygenize() с параметром use.Rd2 = TRUE. У меня есть файл testcase.R, где я создаю простой объект S3, используя R.oo. Вот содержимое файла. Здесь нечего делать, и он должен игнорировать содержимое: library( R.oo ) setConstructorS3( "TestC…
25 авг '11 в 19:22
2
ответа
Экранирование цитат в документации по roxygen в R
У меня есть пример функции R в моей документации, который должен экранировать цитаты: #' @examples msearch("published_in:\"Journal of Ecology\"") (Или, по крайней мере, я не достаточно умен, чтобы избежать цитирования). В то время как эта команда ра…
08 фев '12 в 21:27
1
ответ
Автоматическая документация наборов данных
Сейчас я работаю над проектом, в котором я медленно накапливаю кучу разных переменных из разных источников. Будучи несколько умным человеком, я создал отдельный подкаталог для каждого в главном каталоге "original_data" и включил файл.txt с URL-адрес…
02 ноя '11 в 11:30
0
ответов
Как я могу наиболее чисто использовать Roxygen2 для документирования вектора в R
Я пишу пакет и использую Roxygen2 для создания документации внутри исходных файлов (и pkgdown для их отображения в качестве веб-сайта). У меня есть все ключевые экспортируемые функции, документированные - пока все хорошо. Однако в пакете есть нескол…
29 июл '18 в 13:12
0
ответов
Получение Roxygen не может открыть файл / разрешение запрещено / выполнение остановлено
Итак, я пытался собрать и загрузить пакет и получаю эту ошибку devtools::document(roclets=c('rd', 'collate', 'namespace')) Updating stat290.ass2 documentation Loading stat290.ass2 Error in file(con, "r") : cannot open the connection Calls: suppressP…
05 фев '19 в 19:10
1
ответ
Добавление символа степени в roxygen2
Как добавить символ степени, используя roxygen2 для R документация? °C работает в pdf, но это html, оно отображается как °C, Вот информация о сессии. R version 3.4.0 (2017-04-21) Platform: i386-w64-mingw32/i386 (32-bit) Running under: Windows 7 (bu…
06 авг '17 в 15:47
1
ответ
Эффективная консолидация исходного кода из нескольких файлов в один файл, включая комментарии (Roxygen)
Вопрос Как эффективно объединить исходный код из нескольких исходных файлов в один исходный файл, включая комментарии к документации Roxygen и, возможно, также другие комментарии? Я помню, что в каком-то пакете был метод синтаксического анализа, кот…
12 сен '12 в 15:28
2
ответа
Когда я пишу свой собственный R-пакет, я не могу заставить другие пакеты правильно импортировать
Хорошо, первая попытка написать пакет R, и я застрял. Вот как я создаю пакет: package.skeleton("pkg",code_files=some.filenames) roxygenize("okg") Я использую roxygen2 и у меня есть следующий импорт в моем файле "pkg-package.R": @import data.table zo…
25 апр '12 в 23:29
1
ответ
Где не так в этом содержании в документации R
Я использую roxygen для генерации документации R, все работает отлично, за исключением добавления этого примера @example dIconTr(c(c(1:2), NA)) and the answe is TRUE, dIconTr(c(1:2)) and the answer is FALSE и сообщение об ошибке: cannot open file '/…
24 май '15 в 12:05
0
ответов
Используйте функцию в пакете R, которая зависит от другой, другой функции
Я пытаюсь использовать функцию Mclust() от mclust пакет в другой, другой пакет. Тем не менее, похоже, что Mclust() требует другой функции, mclustBIC, от mclust Пакет для работы: mod1 = mclust::Mclust(iris[,1:4]) #> Error in mclustBIC(data = struc…
10 окт '17 в 21:50
0
ответов
Ошибка преобразования документации Rd в PDF-руководство
Я пытаюсь преобразовать документацию Roxygen, которую я написал для моего собственного пакета R, в файл PDF. Я использовал код, который я нашел в другом посте ( Создание руководства PDF для пакета R с помощью devtools), и он работал для меня раньше:…
04 сен '17 в 12:52
1
ответ
Игнорировать файл (ы) с Roxygen
Я совершенно новичок в (и не желаю учиться) создании / администрировании пакетов, так что извините, если я задам что-то тривиальное. Я знаком с gitТем не менее, и я хотел бы знать, есть ли подобная функциональность .gitignore в roxygen, Так как я ис…
23 ноя '11 в 16:17
0
ответов
Запустите roxygen при установке пакета
Я работаю над пакетом R, который теперь использует Roxygen для документации. Если пользователи хотят установить новую версию пакета (не на CRAN, а на GitHub), им придется сделать это git pull а затем в сеансе R devtools::document() install.packages(…
14 мар '18 в 18:05
0
ответов
Как мне заставить roxygen2 сгенерировать документацию для кода, содержащегося в подпапках папки R/?
Мой код структурирован так: [Папка пакета]человек/ Р/модели /model_a.R model_b.R helper_functions /utils_a.R utils_b.R main.R Тесты / ОПИСАНИЕ NAMESPACE Когда я запускаю roxygen2, я получаю только документацию для main.R. Как я могу получить докумен…
15 окт '18 в 17:18
1
ответ
Сборка пакетов R - ошибка: пример требует значения
Когда я собираю свой пакет, я получаю эту ошибку. Можете ли вы помочь мне узнать, как избежать этой ошибки? #' Square a number #' #' Takes in any numeric value and squares it #' @param x A value to be squared #' @return The square of the input #' @e…
01 май '14 в 09:29
1
ответ
Ускорение содержания кислорода
Бег R CMD roxygen на большую упаковку может уйти довольно много времени. Это очевидно неэффективно, а также проходит через все, независимо от того, изменился ли файл с момента последнего вызова roxygen. Любые советы о том, как ускорить процесс?
20 янв '11 в 15:29
0
ответов
Добавление useDynLib через Roxygen
Я конвертирую свои пакеты в документацию roxygen через пакет roxygen2. Теперь мой пакет не загружается, и я думаю, что это из-за отсутствующего вызова useDynLib(mypackage), отсутствующего в файле NAMESPACE. Как мне это сгенерировать?
06 дек '11 в 22:13
1
ответ
Сохранение отступа в разделе примеров
Roxygen сделал мою работу намного проще и в большинстве случаев приятной и интуитивно понятной. Однако я никогда не понимал, как сохранить отступ в разделах @examples, чтобы результат roxygenize("myPackage") содержащий #' @examples #' sapply(1:10, f…
08 авг '11 в 13:19