<commit_before>Literate Documentation for R Packages [![Build Status](https://travis-ci.org/robertzk/rocco.svg?branch=master)](https://travis-ci.org/robertzk/rocco) [![Coverage Status](https://coveralls.io/repos/robertzk/rocco/badge.svg?branch=master)](https://coveralls.io/r/robertzk/rocco)
--------------------

Literate documentation for R packages in the spirit of Coffeescript's [docco](https://github.com/jashkenas/docco)
featuring syntax highlighting using [highlight.js](https://highlightjs.org/).


Acknowledgements
----------------

Many thanks go to

 * The [highlight.js](https://highlightjs.org/) project for the Javascript-based
   R syntax highlighting.

 * [<NAME>](https://github.com/sindresorhus) for the [Github Markdown style](https://github.com/sindresorhus/github-markdown-css).<commit_msg>Add usage note in README<commit_after>Literate Documentation for R Packages [![Build Status](https://travis-ci.org/robertzk/rocco.svg?branch=master)](https://travis-ci.org/robertzk/rocco) [![Coverage Status](https://coveralls.io/repos/robertzk/rocco/badge.svg?branch=master)](https://coveralls.io/r/robertzk/rocco)
--------------------

Literate documentation for R packages in the spirit of Coffeescript's [docco](https://github.com/jashkenas/docco)
featuring syntax highlighting using [highlight.js](https://highlightjs.org/).

To document your package, simply run

```R
rocco::rocco("/path/to/package") # Will open browser interactively.

# This will install the rocco docs to /path/to/pkg/inst/docs/rocco
rocco::rocco("/path/to/pkg", "/path/to/pkg/inst/docs/rocco", browse = FALSE)
```

Acknowledgements
----------------

Many thanks go to

 * The [highlight.js](https://highlightjs.org/) project for the Javascript-based
   R syntax highlighting.

 * [<NAME>](https://github.com/sindresorhus) for the [Github Markdown style](https://github.com/sindresorhus/github-markdown-css).
{'fraction_non_alphanumeric': 0.1841688654353562, 'fraction_numerical': 0.0, 'mean_word_length': 4.29608938547486, 'pattern_counts': {'":': 0, '<': 5, '<?xml version=': 0, '>': 5, 'https://': 18, 'lorem ipsum': 0, 'www.': 0, 'xml': 0}, 'pii_count': 0, 'substrings_counts': 0, 'word_list_counts': {'cursed_substrings.json': 0, 'profanity_word_list.json': 0, 'sexual_word_list.json': 0, 'zh_pornsignals.json': 0}}
{'dir': 'git-commits-cleaned', 'id': '4451744', 'n_tokens_mistral': 650, 'n_tokens_neox': 589, 'n_words': 117}