Как узнать, кто внес идеи (а не код) в пакет R (используя roxygen2)?

Question

Кто-то может помочь с пакетом R несколькими способами, включая

1. Значительный объем оригинального кода / идей (author или contributor)
2. Некоторые тривиальный код (например, исправление опечатки) (возможно contributor)
3. Нет кода, но есть идеи или экспертиза предметной области (??)

В первом случае author роль будет наиболее подходящей. В roxygen2 это может выглядеть так (aut):

Authors@R: c(
    person("Hadley", "Wickham", , "hadley@rstudio.com", c("aut", "cre"), comment = c(ORCID = "0000-0003-4757-117X")),
    person("Romain", "Fran\u00e7ois", role = "aut", comment = c(ORCID = "0000-0002-2444-4226")),
    person("Lionel", "Henry", role = "aut"),
    person("Kirill", "M\u00fcller", role = "aut", comment = c(ORCID = "0000-0002-1416-3412")),
    person("RStudio", role = c("cph", "fnd"))
    )

Во втором случае роль contributor может (или не может) быть подходящей. например,

Authors@R: c(
    person("Some", "One", , "someone@rstudio.com", c("ctb"))

Но когда кто-то помогает с идеями / обсуждением / экспертизой в области, но не имеет предоставленного кода (случай 3), это contributor роль по-прежнему уместна, и если нет, то изменится ли это, если идеи сформировали направление пакета - т.е. их идеи были очень важными, несмотря на то, что они не писали код.

Что я знаю до сих пор

Библиотека Конгресса 1039 * определяет contributor как

Человек, семья или организация, ответственные за внесение вклада в ресурс , Это включает в себя тех, чьи работы были внесены в более крупные работы, такие как антология, серийные публикации или другие сборники отдельных работ. Если доступна более конкретная c роль, предпочтительнее, например, редактор, компилятор, иллюстратор

Другая возможность: conceptor

Лицо или организация, ответственные за оригинальная идея, на которой основана работа, включает в себя научного c автора аудиовизуального элемента и концептуального автора рекламы

Но это, кажется, указывает на целое работа / пакет основаны на их идее (что может быть правдой, но не обязательно)

Другие ссылки

Хэдли определяет авторов как

тех, кто внес меньший вклад, например, патчи.

Вопрос

Какова подходящая роль для человека, у которого только входные данные - это идеи (а не код), и существуют ли другие способы назначения должного уважения тем, кто предоставляет важные идеи пакету R (например, примечание в README.md, отдельный файл, например CONTRIBUTIONS, файл в каталоге root, что-то еще ??)

Answer 1

tl; др Я бы выбрал между aut и ctb в зависимости от величины вклада (как говорит @Dason, ctb s не должен иметь письменный код). Поскольку вы сказали, что «их идеи были очень важными», похоже, что aut было бы уместно.

LO C ссылки в порядке, но прямое руководство от R-Core находится в ?person и в статье Курта Хорника (член R-core) R Journal (в этих источниках более подробно, чем Написание расширений R , в которой просто сказано " См. ?person для получения дополнительной информации. "). Из статьи Хорника:

В общем, хотя поддерживаются все коды отношений MAR C, при назначении ролей лиц в контексте создания пакетов R предлагается следующее использование:

• "aut" (Автор): Полные авторы, которые внесли существенный вклад в пакет и должны быть указаны в цитировании пакета.
  
• "ctb" (Автор): Авторы, у которых есть внесли меньший вклад (, например исправления кода и c.), но не должны отображаться в цитировании пакета [выделение добавлено]

Ни одна из других ролей (com, cph, cre, ctr, dtc, fnd, rev, ths, trl) здесь кажутся актуальными.

Не знаю Не думаю, что есть какое-либо другое стандартизированное место для предоставления информации о вкладе, но вы можете добавить информацию либо в общий файл справки пакета с псевдонимом pkgname -package , либо в поле комментария для пакета участник:

Поле «Комментарий» c может использоваться для «произвольной» дополнительной информации о лицах.

Answer 2

Нет ничего в описании для участников, которые говорят, что им нужно написать код, насколько я могу судить.