Describe package structure about bc

[karthik]

We can summarize from this section of writing R packages. However, I don't see an organic place for this to go unless we start a new file on Writing R packages. It doesn't make sense in documentation.md or testing.md

thoughts?

[jdblischak]

I think it would make the most sense to be at the beginning of documentation.md because you mention package structure right after the motivation for documenting code. I propose a structure like the following:

• Motivation for documenting code
• R package structure
• The role of roxygen2 in facilitating code documentation when writing R packages.

But that does bring up a bigger question: does it make sense to document functions in the style of roxygen2 outside of package development? I know of no way to generate the nice documentation pages for standalone scripts. While certainly it doesn't hurt to have the documentation in roxgygen2 format, that certainly raises the activation energy required to document functions without any of the extra payoff.