search

analyticalmonk / Rperform

:bar_chart: R package for tracking performance metrics across git versions and branches.
https://analyticalmonk.github.io/Rperform
GNU General Public License v3.0
65 stars 9 forks source link

examples? #3

Closed tdhock closed 9 years ago

tdhock commented 9 years ago

Can you please post some examples about how to use the code that you have developed so far?

Usually I post some code examples in a README.org (or README.md) file in the root directory of each of my github repositories. For example https://github.com/tdhock/PeakSegJoint/blob/master/README.org has installation and example instructions. I would recommend you do the same for your project.

Also you should write brief examples in the Rd files for each of your package's functions, see https://support.rstudio.com/hc/en-us/articles/200532317-Writing-Package-Documentation for more details.

analyticalmonk commented 9 years ago

I have added a README for the project as well as the initial documentation for the package.