benmarwick / rrtools

rrtools: Tools for Writing Reproducible Research in R
Other
671 stars 85 forks source link

allegedly missing documentation entries: use_analysis #53

Closed nevrome closed 6 years ago

nevrome commented 6 years ago

We get this weird warning in the R package check.

Status: 1 WARNING
checking for missing documentation entries ... WARNING
Undocumented code objects:
  ‘use_analysis’
All user-level objects in a package should have documentation entries.
See chapter ‘Writing R documentation files’ in the ‘Writing R
Extensions’ manual.

use_analysis() is of course documented. There's a stackoverflow thread that discusses a similar problem. Maybe this could be fixed by changing the function name, but I hope for a more elegant solution.

@benmarwick I'm pretty sure that we already discussed about this some months ago. But maybe it's good to have an open bug report to keep this in mind. It's not an important issue, but mildly unsatisfying.

benmarwick commented 6 years ago

Looks like we're getting this error because we have analysis in .Rbuildignore. I think that's causing it to match any file with 'analysis' in the name, and exclude those files from the build, which is where the warning is coming from.

Following the instructions here I've changed it to ^analysis/ to specify that we only want to exclude the directory named analysis.