Автор vs Contributor для пакета R - какая роль для небольшого вклада кода?

Question

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

Почему это важно

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

Что Библиотека конгресса говорит

Автор:

Лицо, семья или организация, ответственные за создание произведения, имеющего преимущественно текстовое содержание, независимо от типа носителя (например, печатного текста, произнесенного слова, текста на электронике c, тактильного текста) или жанра ( например, стихи, романы, сценарии, блоги). Используйте также для лиц и т. Д. c., Создавая новое произведение, перефразируя, переписывая или адаптируя произведения другого автора, так что изменение существенно изменило природу и содержание оригинала или изменило среду выражения

Автор:

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

Возможные путаницы

• Когда запрос на получение принят, github будет называть создателя PR «вкладчиком»
• В повседневной беседе тот, кто вносит полезный вклад в проект, может быть разумно назван «вкладчиком»

Answer 1

Как указывалось в предыдущих ответах, идея состояла в том, чтобы различить guish, насколько существенны различные вложения кода. Страница руководства ?person объясняет:

В новой схеме также добавлена ​​возможность указания ролей на основе подмножества MAR C списка кодов для связывателей (URL: https://www.loc.gov/marc/relators/relaterm.html). При определении ролей лиц в контексте создания пакетов R предлагается следующее использование:

• "aut" (Автор) Используйте для полных авторов, которые внесли существенный вклад в пакет и должны показать в цитировании пакета.
• "cre" (Создатель) Используйте для сопровождающего пакета.
• "ctb" (Автор) Используйте для авторов, которые внесли меньший вклад (например, исправления кода и т. д.). c.) Но не должно отображаться в цитировании пакета.

Здесь также приводятся предложения по использованию дополнительных ролей в контексте пакетов R ("com", "cph", "ctr", "dtc", "fnd", "rev", "ths", "trl"). Упомянутая выше цитата - это цитата "по умолчанию" или "авто", которую вы получаете из citation("foo"), если в пакете "foo" нет выделенного файла CITATION. Если он есть, вы все равно можете получить значение по умолчанию citation("foo", auto = TRUE). См. ?citation для получения более подробной информации.

Возвращаясь к вопросу «автор» и «участник»: когда мы писали документацию выше (и сопроводительный документ Хорника и др. в The R Journal) мы сознательно просто дали приблизительные указания, потому что окончательное решение о том, что является «достаточно существенным», должны быть приняты самими авторами пакета. Это не похоже на решение о том, кого включать в список авторов научной статьи c, а не упоминать в благодарностях - для которых практика также сильно различается по дисциплинам / сообществам.

Стратегия, которая не редкость - различать guish три уровня вклада:

• Те, кто внесли очень небольшие вклады (например, небольшие исправления или улучшения), не перечислены в ОПИСАНИИ, но признаны в НОВОСТЯХ или журнал изменений. Это относится ко многим небольшим вкладам, сделанным с помощью трекеров ошибок / проблем или небольших запросов извлечения на GitHub или аналогичных платформах.
• Те, кто предоставил более крупные исправления, небольшие вспомогательные функции, дополнения для конкретных c случаев и т. Д. c , которые должны быть указаны в ОПИСАНИИ как «участники» (ctb). Это также относится к случаю, когда части кода копируются из других пакетов или других источников.
• Те, кто сделал более крупные и / или продолжающие вклады, которые являются достаточно существенными, чтобы быть перечислены в качестве «авторов» (aut) в ОПИСАНИИ и пакет по умолчанию / автоматическое цитирование.

Ссылка: Hornik K, Murdoch D, Zeileis A (2012). «Кто что сделал? Роли авторов пакетов R и как к ним обращаться». The R Journal , 4 (1), 64-69. дои: 10,32614 / RJ-2012-009

Answer 2

Я думаю, что это действительно интересный вопрос, и я задавался вопросом об этом раньше.

К сожалению, я не думаю, что два определения, которые вы предоставляете, настолько ясны, как вы думаете. Одна из проблем заключается в том, что, основываясь на том, как вы их читаете, вы можете утверждать, что автор и участник являются правильными метками для того, кто пишет код в пакете. Достаточно взглянуть на то, что представляет собой пакет R в категориях, используемых в определениях:

Вы можете увидеть пакет как «работу, которая в основном имеет текстовое содержание, независимо от типа носителя» - в этом случае кто-то писать о нем будет автор - или «подборка отдельных произведений» - в этом случае кто-то, кто добавил отдельное произведение, например функцию, станет автором.

В книге » R пакеты "от Хэдли Уикхема, раздел об авторе должен сказать следующее:

• cre: создатель или сопровождающий, человек, которому вы должны беспокоить, если у вас есть проблемы.

• aut: авторы, те, кто внес значительный вклад в пакет.

• ctb: участники, те, кто внесли меньший вклад, как патчи.

(Первоначальный источник этого, кажется, эта статья: Hornik, Murdoch and Zeileis (2012) )

Использование размера Вклад в определение того, является ли кто-либо автором или соавтором, кажется хорошим способом справиться с различием.

Оставляет проблему, каков существенный вклад. В конечном счете, я думаю, что об этом нужно договориться между авторами и участниками. В идеале, существует руководство, установленное создателем / сопровождающим, или вопрос обсуждается до возможного PR.

Практическое правило, которое я предлагаю, состоит в том, чтобы спросить, существуют ли основные функции пакета без вклада одного человека . Если ответ «нет», то этот человек является автором. Если ответ «да, но они не будут работать так же хорошо», я думаю, что этот человек должен внести свой вклад.