Как создать заглушку для страницы справки для новой функции? - PullRequest
1 голос
/ 22 января 2020

Я написал код R, запустил package.skeleton(), отредактировал страницы справки в каталоге man/, собрал и опубликовал пакет.

Сейчас я работаю над версией 2 и добавляю несколько функции к коду. Как мне создать заглушки для их страниц справки? Если я запускаю package.skeleton(force=TRUE), это загромождает страницы справки в man/ Я уже редактировал для версии 1.

Конечно, я мог бы сохранить создайте резервную копию каталога man/, затем запустите package.skeleton(force=TRUE), затем скопируйте резервную копию в man/, наконец отредактируйте оставшиеся вновь созданные заглушки ... но разве нет более простого способа? Я просмотрел «Написание расширений R», но ничего не нашел.


MWE:

  1. Для версии 1 наш файл code_file.R содержит одну строку:

    foo <- function() print("foo")
    
  2. Мы запускаем

    package.skeleton(name="test",code_files="code_file.R")
    

    , который создает файл-заглушку test/man/foo.Rd.

  3. Редактируем test/man/foo.Rd. (Мы создаем и публикуем sh пакет, не относящийся к делу.)

  4. Для версии 2 мы добавляем следующую строку в code_file.R:

    bar <- function() print("bar")
    
  5. Теперь, как нам получить заглушку для test/man/bar.Rd, не заглушая существующий test/man/foo.Rd?

1 Ответ

1 голос
/ 22 января 2020

Вы можете использовать utils::prompt() для создания страницы помощи скелета. См. Документацию на ?prompt для получения полной информации.

...