Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Gitignore man directory of an R package?

Tags:

git

r

r-package

Because each and every file in the man/ directory of an R package is automatically written with package roxygen2, I wonder what would prevent me from adding the entire directory to my .gitignore.

In other words, why all R packages on GitHub still version the man/ directory?

like image 609
F. Privé Avatar asked Aug 23 '17 08:08

F. Privé


1 Answers

As a convenience to users who use devtools::install_github().

If man/*.Rd is not in the repo, they will get a note like No man pages found in package... upon install and later, help(...) or ?... or ??... will fail for your users with No documentation or No results found.

like image 74
Katrin Leinweber Avatar answered Oct 01 '22 08:10

Katrin Leinweber