Какое хорошее имя пакета R?
Я ищу доброе имя для пакета R, который я хочу отправить в CRAN. Я не нашел никакой информации о хорошей практике в Namming R-пакета. Там есть сообщение о том, как анализировать имена пакетов, но это не отвечает на мой вопрос. Существует также алфавитный список пакетов CRAN, но он показывает только то, что существует, а не то, что хорошо на практике.
Возможные варианты:
- Размер: держите имя коротким (8 символов или меньше), тогда его легко вызвать с помощью
library(thepack)
, но, возможно, не mayningfull как the_next_package
;
- Стиль верблюда: используйте стиль Camel (например,
thePack
), чтобы разбить слова, но с риском для пользователя опечатать его при вызове с учетом регистра (library(thepack)
не равно library(thepack)
);
- Специальный символ: использование специальных символов типа "." или "_", чтобы разбить слова (например,
the_pack
или the.pack
), но я не считаю их элегантными
- R-буква: добавьте верхний регистр R, чтобы указать, что R-пакет (например,
Rpack
или theRpack
), но мы имеем ту же проблему, что и стиль Camel.
Это может быть тривиальный вопрос, но я думаю, что имя пакета важно, потому что это первое взаимодействие между пакетом и пользователем. Затем должен быть в то же время значимым, кратким и легким для записи при вызове с помощью функции library()
.
Ответы
Ответ 1
Написание R-расширений предоставляет только следующие ограничения:
Обязательное поле "Пакет" указывает имя пакета. Это должно содержать только буквы (ASCII), цифры и точки, иметь как минимум два символа и начинаться с буквы, а не заканчиваться точкой.
Обратите внимание, что использование подчеркивания не допускается.
Хорошим местом для начала является изучение листинга здесь - например. не так много пакетов используют точку char.
Кроме того, посмотрите на этот вопрос SO для некоторого кода, который может помочь вам в учебе. Что еще, @agstudy предоставил вам ссылку на подсказки Hadley Wickham на его любимую схему именования pkg здесь.
Кстати, если вы думаете о отправке своего пакета на CRAN, обратите внимание, что сопровождающие могут предложить вам изменить имя, если оно не подходит.