Описание тега roxygen2

Описание тега Вопросы с тегом
NoneRoxygen2 - это похожая на Doxygen система документации в исходном коде для Rd, сопоставления и NAMESPACE. Его основное использование - документирование функций R в соответствии с определением функции.
3 ответа

Добавьте разделы в справку / документацию пакета R

Немного R пакеты (например, ggplot2, dplyr,devtools и т. д.) имеют разделы в справке / документации, озаглавленные в алфавитном порядке, и панель ссылок на эти разделы (обозначены красными стрелками на рисунке ниже). Другие пакеты (например, RcmdrMi…
27 фев '16 в 15:06
1 ответ

Как `\ связать {}` с определенным разделом и файлом Rd с Roxygen2?

Скажем, я хочу сослаться на раздел "Подробности" моей документации для функции foo, что я делаю? \link{foo:Details} не похоже на работу, так что такое правильная команда?
05 фев '14 в 13:16
2 ответа

Двуязычная (английская и португальская) документация в пакете R

Я пишу пакет для облегчения импорта бразильских социально-экономических наборов микроданных (перепись, PNAD и т. Д.). Я предвижу две отдельные группы пользователей пакета: Пользователи в Бразилии, которые могут чувствовать себя более комфортно с док…
18 май '16 в 01:39
1 ответ

Исключить функцию из руководства по пакету R

Я пишу пакет R и документирую все свои функции с помощью roxygen2. Однако я не хочу, чтобы все функции появлялись в руководстве к пакету. Как я могу указать, какие функции должны появляться в руководстве по пакету, а какие нет? Я знаю, что присвоени…
04 мар '16 в 17:00
1 ответ

Как импортировать набор данных (используя директиву roxygen)

В пакете "R", который использует roxygen2, я использую встроенный набор данных в приведенном мною примере кода. При сборке и проверке пакета я получаю Consider adding importFrom("datasets", "CO2") importFrom("grDevices", "dev.list", "dev.off") ... З…
16 июн '16 в 15:51
1 ответ

Почему в файле.Rd нет ссылки на другую функцию, когда я \code{\link{functionname}}?

Я использую package::roxygen2 разработать пакет с RStudio. Ниже приведены подробные комментарии к одной из моих функций, которая называется coltrain(), #' Collect raw training data using external SQL queries. #' #' @details This is a wrapper for the…
09 сен '14 в 18:29
1 ответ

Класс 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 frequen…
04 май '17 в 00:35
1 ответ

Rstudio Roxygen2 @importFrom parsing function header

Я строю пакет с Rcpp с использованием Rstudio. Все работало нормально, пока я не добавил разметку для документации в свой функциональный файл. Я надеюсь, что пропускаю что-то очевидное. Вот мой файл функций R: #' @useDynLib tablr #' @importFrom Rcpp…
15 окт '14 в 15:51
0 ответов

Как получить доступ к пользовательской среде в примерах пакетов в R

У меня есть пакет R, в котором я определяю пользовательскую среду при загрузке пакета, используя функцию.onLoad(). Это работает нормально, но когда я документирую функцию с помощью rxoygen2 и выполняю devtools::check(), если есть какая-либо ссылка н…
23 фев '15 в 08:56
1 ответ

Создание файла документации пакета

Я нахожусь в процессе создания пакета R, используя devtools. Кажется, что большинство пакетов в CRAN имеет файл документации, который охватывает все документированные функции. Как мне это построить? У меня есть pkgname.R, вот так: #' _PACKAGE #' @en…
22 фев '16 в 13:35
1 ответ

Как использовать данные внутри функции в пакете R?

В настоящее время я пишу функцию для пакета R. Часть того, для чего предназначена эта функция, состоит в том, чтобы (а) принимать данные в качестве входных данных и (б) сверять один из столбцов со списком допустимых значений. Эти приемлемые значения…
11 июл '17 в 20:51
1 ответ

### ** Примеры... Ошибка: не удалось найти пакеты построения функций в R

Я создал пакет с именем test и у меня есть функция с именем lad внутри него. Когда я его создаю и после проверяю cran=TRUEЯ получаю следующую ошибку. Есть идеи, что не так? * checking examples ... ERROR Running examples in 'test-Ex.R' failed The err…
01 май '14 в 21:25
1 ответ

Контроль, где документация метода идет для простого универсального, скрываясь от индекса пакета

Я пишу пакет R и в основном следую книге Хэдли на эту тему. Я сталкиваюсь с проблемой с методами документирования для простых обобщений, таких как печать, сюжет, голова и хвост. Когда я использую тег @describeIn для управления тем, куда идет докумен…
17 апр '16 в 15:11
1 ответ

Как устранить предупреждение Roxygen о "Имя не найдено..."?

Я вызываю roxygenize() с параметром use.Rd2 = TRUE. У меня есть файл testcase.R, где я создаю простой объект S3, используя R.oo. Вот содержимое файла. Здесь нечего делать, и он должен игнорировать содержимое: library( R.oo ) setConstructorS3( "TestC…
25 авг '11 в 19:22
0 ответов

Документирование данных с помощью пакета R

С помощью roxygen2 а также devtools создать свой собственный пакет. У меня есть некоторые данные, которые я хотел бы включить в свой пакет (хранится в data/mydata.rda). Я задокументировал эти данные в формате roxygen на R/mydata.R: #'This is my data…
16 фев '17 в 15:33
1 ответ

Ошибка roxygen2: ошибка в начале блока roxygen... @data - неизвестный ключ

После недавнего обновления до R 3.1.1, то, что раньше давало мне предупреждение со старой версией R, теперь выдает эту ошибку при использовании devtools::document в RStudio (Ctrl + Shift + D): ==> devtools::document(roclets=c('rd', 'collate', 'na…
12 авг '14 в 17:53
1 ответ

Документация Roxygen для существующих дженериков

Я написал show() метод для класса S4 myclass который я определил в моем пакете. Я создал документацию для класса и метода с roxygen2. Все работает хорошо, за исключением того, что я получаю следующее предупреждение в результатах проверки CMD R: пров…
21 мар '18 в 13:46
2 ответа

Roxygen2 сообщает об ошибке: файл уже существует.../RcppExports.cpp

Я занимаюсь написанием пакетов R с Rcpp, devtools и roxygen2. Однако, когда я запускаю document("mypkg") в режиме dev, я получаю следующую ошибку: Updating mypkg documentation Loading mypkg Error: file already exists: 'mypkg/src/RcppExports.cpp' Мой…
12 май '14 в 13:51
1 ответ

Как отобразить элементы возвращаемого списка в Roxygen?

Я могу сделать это легко с входными параметрами, имея несколько строк @param делая так: #' @param var1 This is for x #' @param var2 This is for y #' @param var3 This is for Z Но как вы делаете это для элементов списка, который вы возвращаете. Я хочу…
29 янв '16 в 21:26
0 ответов

Импорт RSQLite в R-пакет

Я пытаюсь добавить пакет RSQLite в Imports вместо Depends в моем пакете. В ОПИСАНИИ у меня есть: Imports: sqldf, RPostgreSQL, RSQLite В NAMESPACE есть: import(RPostgreSQL) import(RSQLite) import(sqldf) Но тогда, когда я загружаю свой пакет, это терп…
17 дек '13 в 10:54