Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

create proper documentation for all public functions #38

Open
pmayd opened this issue Mar 29, 2023 · 0 comments
Open

create proper documentation for all public functions #38

pmayd opened this issue Mar 29, 2023 · 0 comments

Comments

@pmayd
Copy link
Collaborator

pmayd commented Mar 29, 2023

As we are moving to a proper R package for our project, I want to use document() from devtools to automatically create the documentation files that are understood by RStudio so we have proper documentation for our functions.

So we should annotate all functions like

#' Split a string
#'
#' @param x A character vector with one element.
#' @param split What to split on.
#'
#' @return A character vector.
#' @export
#'
#' @examples
#' x <- "alfa,bravo,charlie,delta"
#' strsplit1(x, split = ",")
strsplit1 <- function(x, split) {
  strsplit(x, split = split)[[1]]
}
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant