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

Provide definitions of all columns in input and output data tables #1

Open
hillalex opened this issue Jul 12, 2024 · 0 comments
Open
Assignees
Labels
documentation Improvements or additions to documentation

Comments

@hillalex
Copy link
Member

The model accepts a table of data with some required columns. These should be documented in full.

It also outputs data tables from the following 3 functions:

Each of these output a number of columns with non-human readable names. These should be fully documented. Note that for some functions, the columns outputted may be different depending on whether a summarise argument is provided.

All this documentation should live in the data vignette.

@hillalex hillalex assigned hillalex and thimotei and unassigned hillalex Jul 12, 2024
@hillalex hillalex added the documentation Improvements or additions to documentation label Jul 16, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation
Projects
None yet
Development

No branches or pull requests

2 participants