macroevolution / bamm

A program for multimodel inference on speciation and trait evolution
GNU General Public License v2.0
33 stars 10 forks source link

package skeleton #40

Closed drabosky closed 10 years ago

drabosky commented 10 years ago

unless someone has already started documenting things I'd suggest we hold off on package skeleton. I also think we should talk about who documents what and how to document things consistently.

drabosky commented 10 years ago

Maybe it is worth discussing how we should write this. In general, I think whomever writes a given function should be responsible for the documentation, since you are most familiar with it. This also ensures that people aren't duplicating documentation. You can list yourself and anyone else who contributed to the function (but don't list the whole lab as authors for functions, if they didn't author it).

As example datasets, we should have the cetacean tree, the cetacean trait data, sample event data files and prior files for each of those, to actually be included in R. More example datasets in the BAMM distribution, but these are datasets that will be documented in R.

I will plan to create a final package skeleton at the end of this week when I've had more time to think about what else should be included.

redcurry commented 10 years ago

Are you also thinking of what to include in the final, downloadable file for the website? Since the R package will go in CRAN, does that mean it won't be included with the BAMM program?

redcurry commented 10 years ago

What's the status of the package skeleton?

ptitle commented 10 years ago

We've been completing the R package documentation, but more remains to be done.

redcurry commented 10 years ago

Ok, so the issue is completing the R package documentation. I'll close this issue and open a new one that specifically targets R package documentation.