Skip to content

Instantly share code, notes, and snippets.

@jeroen
Created January 9, 2020 12:37
Show Gist options
  • Save jeroen/c71b82fff94f6317e84273fb60e26f01 to your computer and use it in GitHub Desktop.
Save jeroen/c71b82fff94f6317e84273fb60e26f01 to your computer and use it in GitHub Desktop.
#' My roxy
#'
#' This is an example of how you would use roxygen.
#'
#' ```{r}
#' #' Test example
#' #'
#' #' This is an example. Here is how you embed R code:
#' #'
#' #' ```{r}
#' #' sessionInfo()
#' #' ```
#' #'
#' #' @export
#' #' @param foo this is a parameter
#' test <- function(foo){
#' foo^2
#' }
#' ```
#'
#' @export
#' @param args some parameters
myroxy <- function(args){
}
@gaborcsardi
Copy link

Formatted page seems fine:

myroxy                package:roxygen2                 R Documentation

My roxy

Description:

     This is an example of how you would use roxygen.

Usage:

     myroxy(args)

Arguments:

    args: some parameters

Details:

     #' Test example
     #'
     #' This is an example. Here is how you embed R code:
     #'
     #' ```{r}
     #' sessionInfo()
     #' ```
     #'
     #' @export
     #' @param foo this is a parameter
     test <- function(foo){
       foo^2
     }

@jeroen
Copy link
Author

jeroen commented Jan 9, 2020

OK very impressive :)

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment