Вопросы по теме 'roxygen2'
Обработка файлов примеров с помощью roxygen2: дублируются обратные косые черты (\dontrun становится \\dontrun)
Актуальный вопрос
Как я могу избежать того, что \dontrun{ в отдельном файле , содержащем примеры, станет \\dontrun{ в соответствующем файле Rd после roxygenizing?
Я нашел обходной путь, но мне кажется, что я просто упускаю что-то очевидное,...
2087 просмотров
schedule
22.02.2024
Объекты ошибок в \usage без \alias в объекте документации из R CMD Check
Я написал небольшой пакет для собственного использования, и с помощью devtools все прошло очень хорошо. Однако я попытался запустить на нем R CMD Check и получил ряд ошибок, по-видимому, потому, что в моем использовании и примерах используются...
1999 просмотров
schedule
07.04.2022
Как указать порядок сортировки в Roxygen2?
Использование документации roxygen2 с функцией document devtools автоматически создает поле Collate: в ОПИСАНИИ пакета, независимо от того, необходимо ли загружать файлы библиотеки пакетов в определенном порядке.
Я работаю над пакетом с кучей...
1829 просмотров
schedule
15.10.2023
Как переключить комментарии roxygen в Rstudio?
В комментариях Roxygen строки начинаются с префикса #' . При написании и тестировании примеров для функций приятно иметь возможность включать и выключать комментарии. Я мог бы скопировать и вставить код назад и вперед в vim и удалить или добавить...
954 просмотров
schedule
01.05.2022
Как правильно импортировать метод S3 без импорта всего пакета
Я хотел бы использовать одну функцию из пакета с именем myPackage под названием as.data.frame.mywhateverS3class
Когда я смотрю на пакет NAMESPACE, он выглядит следующим образом: S3method(as.data.frame, mywhateverS3class) Я хотел бы...
178 просмотров
schedule
05.06.2023
roxygen2 importFrom и бинарный оператор
Как отформатировать вызов importFrom при использовании roxygen2 ?
Я вижу два подхода:
importFrom base %in%
or
importFrom base `%in%`
Очевидно, что мы не стали бы импортировать базовую функцию в пакет, но это сделано для...
278 просмотров
schedule
23.07.2022
roxygenize: не удается открыть соединение
У меня проблемы с оксигенированием пакета. В последний раз он работал несколько месяцев назад, и с тех пор я не проверял, поэтому не уверен, сломал ли его фрагмент кода, который я добавил, изменилась ли конфигурация моей системы или изменился ли...
1078 просмотров
schedule
10.05.2024
Создание элементов с несколькими аргументами в документации R через roxygen2
Для создания файла документации R ( .Rd ) я использую параметр пакета RStudio/Document с R 3.0.2, Linux 3.11, devtools 1.5, roxygen2 4.0.1.
Цель
Я хочу описать несколько аргументов функции в файле документации, например, в этом примере:...
1170 просмотров
schedule
04.05.2023
Ссылки на другие пакеты в документации в roxygen2 в R
Мне интересно, существует ли метод link для работы из другого пакета, когда я пытаюсь написать документацию для нового пакета, используя roxygen2 . Что-то вроде \link{pck=PACKAGE_NAME, fun=FUNCTION_NAME} ?
12572 просмотров
schedule
03.10.2022
Создайте главную страницу справки (индекс) для пакета R с помощью devtools
Я создаю пакет R с помощью devtools. Вся документация построена с использованием roxygen2. Для функций все работает нормально, но как я могу предоставить страницу справки для всего пакета, на которой перечислены все доступные функции.
В других...
1413 просмотров
schedule
17.11.2022
Как в Sublime Text 3 изменить символ комментария?
Мне нравится функция автокомментирования Ctrl + / , но я хотел бы иметь возможность произвольно менять символ, который она использует. Я прочитал много подобных вопросов, таких как этот , но это не совсем универсальное решение.
Как я могу...
2496 просмотров
schedule
29.04.2022
Документирование расширения статистики ggplot2 — devtools::document() не создает packagename-ggproto.Rd
Я создаю пакет, который будет содержать новую статистику ggplot2.
Я использую ggplot2::ggproto для создания новой статистики, но у меня проблемы с документацией по roxygen2. После запуска devtools::document() я получил:...
240 просмотров
schedule
31.05.2024
Более быстрый способ создания документации пакета R (например, руководства в формате pdf) в roxygen2?
Для пакета, созданного с помощью roxygen2, документация может быть сгенерирована с помощью
R CMD check package_name
Есть ли более быстрый способ создать руководство по пакету (pdf)?
Примечание: это должно работать для пакетов, сделанных...
55 просмотров
schedule
26.05.2022
Документация по объекту R: пакетная документация в качестве первого элемента
У меня есть пакет R, и я хочу отобразить общую информацию о пакете в качестве первого элемента в созданном руководстве в формате PDF.
Я использую roxygen2 (версия 7.0.2) для создания документации и следую приведенным инструкциям здесь . Когда я...
118 просмотров
schedule
23.09.2023
Поиск объектов из пространств имен других пакетов в коде пакета
Я рефакторинг пакета, который импортирует полные пространства имен многих других пакетов. Я считаю, что многие из этих зависимостей используются для вызовов отдельных функций, которые лучше обрабатывать с помощью importFrom, или являются потерянными...
196 просмотров
schedule
28.11.2022