2
ответа

Что такое хороший пример R пакеты записанное использование RUnit или roxygen?

Я пишу пакет R, это будет используемым другими, таким образом, я пытаюсь разобраться в этом! Я хочу использовать roxygen для документации и RUnit для поблочного тестирования, но я не использовал их прежде...
вопрос задан: 23 March 2010 09:40
2
ответа

R документация с Roxygen? [закрытый]

Я нахожу, что документация R является важной, но также и трудоемкой для создавания/поддержания. Кто-либо использовал Roxygen уже, и если так, он помогает в поддержании пакета R? Я использовал Doxygen в прошлом...
вопрос задан: 23 February 2010 05:49
2
ответа

Roxygen может проигнорировать функции лица, не использующего своего права?

Я только что начал играть вокруг с roxygen пакетом, и я имею очень довольный результатами до сих пор. Однако я задавался вопросом, там способ определить к roxygen, что он должен проигнорировать бесспорный...
вопрос задан: 23 February 2010 05:36
1
ответ

Как я могу зарегистрировать наборы данных с roxygen?

Действительно ли возможно включать.R файлы в каталог данных моего пакета в процессе roxygen? Я поместил несколько.R файлов в каталог данных. Когда они получены с данными (), они читают в сырых данных...
вопрос задан: 3 October 2018 21:59
0
ответов

Когда я пишу свой собственный R-пакет, я не могу заставить другие пакеты правильно импортировать

Хорошо, первая попытка написать пакет R, и я застрял. Вот как я создаю пакет: package.skeleton ("pkg", code_files = some.filenames) roxygenize ("okg") Я использую roxygen2 и имею ...
вопрос задан: 25 January 2019 07:46
0
ответов

Как правильно документировать методы S4 «[» и «[<-« с использованием roxygen?

Ниже я разместил мини-пример, в котором я хочу написать документацию для метод «[« для класса S4. Кто-нибудь знает, как правильно задокументировать метод для общего "[" с помощью roxygen и S4? Я ...
вопрос задан: 11 January 2019 15:08
0
ответов

Может ли RStudio автоматически генерировать шаблон roxygen для функции?

Поддерживает ли RStudio автоматическое создание шаблонов roxygen? В Emacs-ESS C-x C-o создаст шаблон roxygen для функции. Например, он автоматически преобразует это: foo <- ...
вопрос задан: 19 July 2018 06:27
0
ответов

При документировании в Roxygen: Как мне составить детализированный список в @details?

Каков подходящий синтаксис для добавления детализированного списка в roxygen2, например, в @details раздел? Могу ли я создать среду списка латекса? Кажется, что разрывы строк просто игнорируются, т.е. ...
вопрос задан: 1 June 2017 14:40
0
ответов

Как я могу документировать наборы данных, не добавляя их в поле «Разобрать по копиям»?

Я использование roxygen2 для документирования наборов данных для разрабатываемого мной пакета. Я знаю, что вы можете использовать roxygen для документирования набора данных, но ответ Шейна в конечном итоге предлагает взлом, которого я бы предпочел избе
вопрос задан: 23 May 2017 12:33
0
ответов

Хорошая ссылка на Roxygen? [закрыто]

Кроме отличного ответа SO здесь, а также руководства и виньетки Roxygen, есть ли какое-нибудь особенно подробное руководство по использованию Roxygen?
вопрос задан: 23 May 2017 12:03
0
ответов

Как добавить псевдоним для класса без универсального псевдонима с помощью Roxygen2?

Простым примером является то, что я создал расширение для демонстрации, которое является базовым методом S4. Я не хочу вызывать разветвление неоднозначности, повторно документируя show в моем пакете, и я также хочу ...
вопрос задан: 23 May 2017 10:26
0
ответов

roxygen2 + cygwin + параметр по умолчанию = усеченный раздел `\usage`

У меня есть пакет для R, который я разрабатывал под Linux, и пришло ужасное время, когда Тестирую под Windows. Документация сделана с помощью roxygen, а я использую cygwin для сборки...
вопрос задан: 1 January 2017 04:27
0
ответов

Roxygen: how to set a default parameter including backslash ('\') to functions

I use Roxygen to generate Rd files of my packages under development, but I have some problems with functions with default parameter set to '\n', e.g.: lineCount <- function(text, sep='\n') { ...
вопрос задан: 10 April 2013 05:39
0
ответов

Как правильно задокументировать метод S3 универсального пакета из другого пакета, используя Roxygen?

I я пишу пакет, который определяет новый класс, инспектор и метод печати для этого, то есть print.surveyor. Мой код работает нормально, и я использую roxygen для встроенной документации. Но проверка R CMD вызывает ...
вопрос задан: 29 March 2013 19:13
0
ответов

Сохранение отступов в разделе примеров

Roxygen значительно упростил мою работу и в большинстве случаев является приятным и интуитивно понятным. Одна вещь, которую я так и не понял, - это как сохранить отступы в секциях @examples, чтобы результат ...
вопрос задан: 6 August 2012 20:23
0
ответов

Как сделать перекрестную ссылку на уравнение в файле справки R / roxygen2

Я в процессе документирования некоторых моих функций для пакета R, который я создаю. Я использую разметку roxygen, хотя это в значительной степени не имеет отношения к моему вопросу. Я поместил уравнения в свой ...
вопрос задан: 22 June 2012 19:18
0
ответов

Документирование функций сеттера с помощью roxygen

У меня есть функция, которая не делает ничего, кроме объявления уникального атрибута любому объекту R. Базовая демонстрация: # 'Функция установки # '@param x объект R # '@param value значение символа для установки # '@export `foo <-` & ...
вопрос задан: 7 June 2012 13:16
0
ответов

Существуют ли передовые/рекомендуемые методы переименования функций в новой версии пакета?

Я обновляю старый пакет и сокращаю кучу очень длинных имен функций. Как сообщить пользователю, что старая функция устарела? Я все документирую с помощью roxygen2, поэтому я...
вопрос задан: 11 April 2012 02:39
0
ответов

R использует s3 и s4 методы simulate в одном пакете

Я озадачен ошибкой, найденной S4 версией 'simulate', поэтому она не была импортирована правильно Я написал пакет R, который включает определение для метода simulate() как S3 метод. ...
вопрос задан: 19 January 2012 05:30
0
ответов

Можно ли использовать данные пакета R в testthat tests или run_examples ()?

Я работаю над разработкой пакета R, используя devtools, testthat и roxygen2. У меня есть пара наборов данных в папке данных (foo.txt и bar.csv). Моя файловая структура выглядит так: / mypackage ...
вопрос задан: 17 January 2012 16:49
0
ответов

Экранирование «@» в документации по стилю Roxygen2

Допустим, у меня есть блок комментариев, в котором я хотел бы написать адрес электронной почты. Как мне избежать символа «@», чтобы roxygen рассматривал его как текст, а не директиву?
вопрос задан: 10 January 2012 19:07
0
ответов

Пишет ли roxygen2 автоматически директивы NAMESPACE для пакетов "Imports:"?

tl;dr версия моего вопроса Если я хочу импортировать пакеты, должен ли я вручную писать директивы import() в моем файле NAMESPACE? Похоже, что roxygen2 не сделает это за меня волшебным образом, даже если я ...
вопрос задан: 22 December 2011 00:09
0
ответов

Автоматическое документирование наборов данных

Я сейчас работаю над проектом, в котором я медленно накапливал кучу разных переменных из кучи разных источников. Будучи несколько умным человеком, я создал другой суб -...
вопрос задан: 10 November 2011 17:18
0
ответов

Включение изображения с помощью документации roxygen

Можно ли включить изображение в документацию, созданную roxygen? У меня есть несколько функций, которые по сути являются оболочками для ggplot (), которые я хотел бы задокументировать, показав пример ...
вопрос задан: 19 October 2011 00:27
0
ответов

roxygen2 «Ошибка: titlerequires a value»

Я получаю сообщение об ошибке от roxygenize (), которое я не могу понять. У меня есть пакет моих разных функций, в котором файлы .Rd генерируются через roxygen. Ошибка: Ошибка: titlerequires a ...
вопрос задан: 6 October 2011 19:50
0
ответов

Документирование классов / методов R.oo с помощью Roxygen

Может ли кто-нибудь указать мне на хороший пример документирования классов / методов R.oo с помощью Roxygen? В R.oo классы / методы создаются вызовами setConstructorS3 () и setMethodS3 (), поэтому нет ...
вопрос задан: 26 August 2011 00:38
0
ответов

Roxygen2 - как правильно документировать методы S3

Я читал PDF-файл Roxygen2, а также этот сайт, и я не понимаю разницы между @method @ S3method @export и того, как вы используете их для правильного документирования методов S3. Я проработал следующее ...
вопрос задан: 26 August 2011 00:24
0
ответов

Можно / рекомендуется отказаться от roxygen в пользу roxygen2? [закрыто]

Недавно меня указали на Roxygen, чтобы решить мои проблемы с документацией / лень. Но есть еще и этот блестящий Roxygen2, который, в моем понимании, в чем-то особенный. Инструменты пакета Хэдли ...
вопрос задан: 7 August 2011 07:21
0
ответов

Произвольные разделы в документации roxygen

Кажется, что Roxygen работает так, что первая строка - это \ title, все остальное находится в \ details, а затем любые директивы @foo обрабатывают эти вещи. Но документация R богаче. Я могу ...
вопрос задан: 10 May 2011 22:27
0
ответов

Почему roxygen не записывает информацию о пакете в ОПИСАНИЕ?

Я следил за Виньеткой и обнаружил, что такая информация, как Лицензия, Автор и т. Д. В pseudoprime-package.Rd не записывается в ОПИСАНИЕ? Я сделал что-то не так?
вопрос задан: 22 April 2011 16:58