R github package w/devtools: warning unknown macro '\ item'

Question

Я сделал пакет с помощью RStudio & devtools для пространства имен, ОПИСАНИЕ & Roxygen2 для страниц руководства. Это сработало хорошо, и страницы справки, которые я недавно добавил, тоже работали. Я решил добавить имя автора, адрес электронной почты и некоторые подробности. Сначала вручную редактировать файл справочной странице (BAD), то редактирование R сценарий Roxygen2 части & толкая изменения в файл Rm с document()

Но: когда я устанавливаю мой пакет

devtools::install_github('SimonDedman/gbm.auto') 

я получаю следующее предупреждения:

Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:35: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:37: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:39: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:41: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:43: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:45: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:47: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:49: unknown macro '\item' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:51: unexpected section header '\value' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:55: unexpected section header '\description' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:65: unexpected section header '\examples' 
Warning: /tmp/RtmpNladba/devtools27303e05b1fc/SimonDedman-gbm.auto-dbe3cb0/man/gbm.valuemap.Rd:69: unexpected END_OF_INPUT ' 
' 

Эти элементы являются только простые @param аргументы, которые я уже не изменились, выглядят хорошо и работали раньше. То же, что и аргументы value/description/examples, которые являются стандартными (но, вероятно, проблема с нисходящим потоком, которая будет решена после устранения проблемы восходящего потока).

Может кто-нибудь подумать, что может вызвать это? Ни одна из моих страниц справки не доступна сейчас, хотя можно было подумать, что независимо от этой проблемы с одним сценарием (gbm.valuemap.R), остальные должны быть в порядке?

Заранее спасибо.

Answer 1

Вы можете использовать RStudio, чтобы помочь в разработке пакета в нескольких аспектах:

1. использование построить & инструмент нагрузки в панели сборки для пакета проекта. Вы можете создавать, обновлять документы (вы можете проверить дополнительные параметры в настройке Roxygen2, некоторые из них не включены по умолчанию), загрузите пакет за один клик. Ошибка, с которой вы столкнулись, должна быть найдена ранее, и вам не нужно вручную устанавливать ее для проверки.

2. использовать функцию предварительного просмотра для .Rd файла

Другой метод заключается в сравнении рабочего и нерабочего исходного файла версии, .Rd файл, чтобы найти разницу.

Следует избегать вообще прямого редактирования сгенерированного файла.

Чтобы сделать этот ответ более полно, вот советы от @Benjamin о форматировании в Rd файлах:

Это может быть & в строках, как «Импорт с (например) read.csv & указать» хотя я не совсем уверен. Я помню, что некоторые знаки препинания были проблематичными, особенно%. Изменение & к и может быть стоит выстрел

От @Thomas:

Можно также придумать, если у вас есть заблудших {где