documentation for waltz function

[cecilesauder]

No description provided.

[romainfrancois]

closes #8

[romainfrancois]

(the previous comment is so that when this PR is merged, this will close the issue #8)

[romainfrancois]

Can you have a title, and then a description ?

[romainfrancois]

you can reference other functions with markdown:

Suggested change

	#'one row per group. It does not prepend the grouping variables (see tango for that).
	#'one row per group. It does not prepend the grouping variables (see [tango()] for that).

[romainfrancois]

Because the original repo romainfrancois/dance has evolved since you started this PR, they now conflict. So we need to resolve these conflicts before we can merge the PR.

The first thing is to configure an upstream, so that you can pull changes from the original (upstream) repo. Open a terminal, go to the dance directory,

git remote add upstream https://github.com/romainfrancois/dance.git

Once you have that, you can follow these steps to update your branch so that it has upstream changes.

git fetch upstream
git merge upstream/master

Because we both changed things at the same places, git does not know which one to keep, there is a conflict, so we need to tell it, i.e. resolve the conflicts.

This will look something like this:

<<<<<<< documentation_waltz
#'waltz() takes a grouped tibble and a list of formulas and returns a tibble with: as many columns as supplied formulas,
#'one row per group. It does not prepend the grouping variables (see tango for that).
#' @param .tbl a grouped tibble
#' @param ... a list of formulas
#' @param .env ?? to do
#' @return a tibble with: as many columns as supplied formulas,
#'one row per group
=======

#' waltz
#'
#' @param .tbl TODO
#' @param ... TODO
#' @param .env TODO
#'
>>>>>>> master

So what's between <<<<<<< documentation_waltz and ======= are your changes, and what's between ======= and >>>>>>> master are my changes.

We need to replace all this. In that case it's easy, you can just replace all by just your version.

The waltz.Rd also has conflicts, but since it's a generated file, the easiest way to deal with those is to just re-generate the file with devtools::document()

[romainfrancois]

Closed as obsolete by this commit: 1920f96

Please don't hesitate to create another pull request if you want to add changes/comments/examples to the docs for these 4 functions.