Как обращаться к файлам /data в пакете R

Question

Я отправил пакет R в CRAN. Мне нужно включить примеры.csv файлов, которые я включил в каталог /data.

Чтобы пройти проверку R CMD, мне нужно иметь примеры в файле.Rd для ссылки на файлы данных.csv, как показано ниже

 pkg-function(system.file("data", <csv file>, package = pkg-name),par1) -- (1)

При использовании этого формата проходит проверку CMD R, а также работает после установки пакета, а не фактические имена путей.

Но я хочу, чтобы пользователь мог обращаться к файлам.csv простым способом, как изложено ниже.

pkg-function(path-to-file, par1) -- (2)

Так как примеры в файле.Rd будут в форме (1), это приведет пользователя в замешательство.

Есть ли чистый способ вызова функций пакета в примерах (.Rd) как format (2)

Answer 1

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

Например:

#* retrieve the file path of a data file installed with
#* [your package's name] 
#* see '?system.file' for details.
Path <- system.file (...)

#* execute function
pkg-function (Path, par1)