Skip to content

Commit

Permalink
fixed README
Browse files Browse the repository at this point in the history
  • Loading branch information
Dason Kurkiewicz committed Oct 4, 2012
1 parent f01328d commit dabca68
Showing 1 changed file with 6 additions and 8 deletions.
14 changes: 6 additions & 8 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@ The `flydoc` package is designed to provide an easy way to document your functio

You can add a help file for your own functions without putting them into a package using the `flydoc` package. There are several ways to do this.

1. Add the documentation using several of the accessor functions. For instance if you have a function `myfunction` you could add documentation using the following syntax
1. Add the documentation using several of the accessor functions. For instance if you have a function `myfunction` you could add documentation using the following syntax

```r
library(flydoc)
Expand All @@ -26,16 +26,14 @@ You can add a help file for your own functions without putting them into a packa
fdExample(myfunction)
```

2. You can have your function in a script with documentation and read it in with the `fdRead` function (not yet implemented). There are two methods to store this documentation planned for the future. You can have roxygen2 style documenation comments in the source code that will be read, parsed, and converted to the appropriate format so that you can use the `fdHelp` function to display. The other alternative is to have normal comments directly after the function definition which will be used as the "description" in the help file. You can add further documentation using the accessor functions.
2. You can have your function in a script with documentation and read it in with the `fdRead` function (not yet implemented). There are two methods to store this documentation planned for the future. You can have roxygen2 style documenation comments in the source code that will be read, parsed, and converted to the appropriate format so that you can use the `fdHelp` function to display. The other alternative is to have normal comments directly after the function definition which will be used as the "description" in the help file. You can add further documentation using the accessor functions.

## Goals

1. Provide help documentation for functions that aren't currently installed in a package.
2. Make the transition to turning local functions into an actual package easier by eventually providing functionality similar to [Rd2roxygen](http://cran.r-project.org/web/packages/Rd2roxygen/index.html) that will generate roxygen comments for you and add them to the scripts directly.
3. Currently I'm settling by using a separate function to access the help files for the documentation created with `flydoc`. Eventually I want this documentation to be accessible directly by using either `help(myflydocfunction)` or `?myflydocfunction`.
4. Currently I'm only allowing displaying text help and am using
`file.show` for this. Unfortunately this doesn't work in RStudio so
I need to find a workaround for that...
1. Provide help documentation for functions that aren't currently installed in a package.
2. Make the transition to turning local functions into an actual package easier by eventually providing functionality similar to [Rd2roxygen](http://cran.r-project.org/web/packages/Rd2roxygen/index.html) that will generate roxygen comments for you and add them to the scripts directly.
3. Currently I'm settling by using a separate function to access the help files for the documentation created with `flydoc`. Eventually I want this documentation to be accessible directly by using either `help(myflydocfunction)` or `?myflydocfunction`.
4. Currently I'm only allowing displaying text help and am using `file.show` for this. Unfortunately this doesn't work in RStudio so I need to find a workaround for that...

## Installation

Expand Down

0 comments on commit dabca68

Please sign in to comment.