Обоснование пакета R: переполненные поля для методов @family перекрестных ссылок - PullRequest
1 голос
/ 22 апреля 2020

Я использую roxygen2 для документирования моего пакета R texreg. В пакете я определяю обобщенную функцию c S4 под названием extract вместе с десятками методов, которые улучшают функциональность других пакетов R. В документации я использую тег @family extract для создания перекрестных ссылок, которые появляются в разделе «См. Также» внизу соответствующей страницы справки каждого метода. Вот пример скриншота из PDF-руководства, которое создается автоматически:

enter image description here

Как видите, в документации есть переполненные поля, некоторые даже касаясь границы страницы. Это само по себе не слишком беспокоит меня (хотя, очевидно, это не выглядит профессионально). Но это происходит на большинстве из 204 страниц руководства, и это приводит к гигантскому лог-файлу. Следствием этого является то, что travis-ci больше не собирает пакет успешно на GitHub. Он заканчивается следующим журналом:

...

Overfull \hbox (25.84094pt too wide) in paragraph at lines 3987--4093
[][]\T1/zi4/m/n/10 extract,clm-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 
extract,clmm-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 extract,clogit-met
hod[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 extract,coeftest-method[][][]\T1/p
tm/m/n/10 ,
 []

Overfull \hbox (55.84094pt too wide) in paragraph at lines 3987--4093
[][]\T1/zi4/m/n/10 extract,coxph-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/1
0 extract,coxph.penal-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 extract,c
oxreg-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 extract,dynlm-method[][][
]\T1/ptm/m/n/10 ,
 []

Overfull \hbox (10.84094pt too wide) in paragraph at lines 3987--4093
[][]\T1/zi4/m/n/10 extract,ergm-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10
 extract,ets-method[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 extract,fGARCH-met
hod[][][]\T1/ptm/m/n/10 , [][]\T1/zi4/m/n/10 extract,feglm-method[][][]\T1/ptm/
m/n/10 ,
 []

Overfull \hbox (15.84094pt too wide) in paragraph at lines 3987--4093
[][]\T1/zi4/m/n/10 extract,feis-method[][][]\T1/ptm/m/

The job exceeded the maximum log length, and has been terminated.

Это прискорбно, потому что он не только выглядит уродливо, но и предотвращает автоматическое тестирование пакета. Как я могу решить эту проблему, кроме очевидного выбора не использовать @family, как это задумано (и, следовательно, ограничить обзор пользователей функциональности пакета)?

...