iago-lito
iago-lito

Reputation: 3208

Run `devtools::document()` before installing

I've just pushed a package on Github, which I regularly document, test and install on my machine with the following R commands:

library(devtools)
library(testthat)
setwd("bimark")
document()     # cheers to roxygen2!
use_testthat() # cheers to testthat!
setwd("..")
install("bimark", build_vignettes=TRUE) # cheers to R-markdown!
library(bimark)
test_package("bimark")
run_examples("bimark")

However, installing it from github with:

install_github("iago-lito/bimark")

does not work since

ERROR: a 'NAMESPACE' file is required

The reason why I do not version my NAMESPACE file is that it is automatically generated by devtools::document().

How can I make the full doc-test-installation easy for my users without versionning non-source files such as NAMESPACE?

Upvotes: 1

Views: 231

Answers (1)

witek
witek

Reputation: 1044

NAMESPACE is autogenerated only if devtools::document() and roxygen2 is used. Otherwise, you create it by hand. Therefore, I think they consider it as a source file which needs to be versioned.

Upvotes: 1

Related Questions