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

Improve documentation of dk_activity_units.R #68

Open
3 tasks
RasmusSkytte opened this issue Nov 9, 2023 · 0 comments
Open
3 tasks

Improve documentation of dk_activity_units.R #68

RasmusSkytte opened this issue Nov 9, 2023 · 0 comments
Assignees
Labels
backlog This will be worked on in the future documentation Improvements or additions to documentation good first issue Good for newcomers
Milestone

Comments

@RasmusSkytte
Copy link
Contributor

RasmusSkytte commented Nov 9, 2023

In the beginning of data-raw/dk_activity_units.R we have the following template:

# Template for adding new units: dk_activity_units |>                                                                 
# add_activity(activity = "<programmatic short hand for activity>",
#              label  = "<human readable label for activity>",
#              home = <number in [0, 1]>,
#              work = <number in [0, 1]>,
#              school = <number in [0, 1]>,
#              other = <number in [0, 1]>,
#              risk = <number in [0, 1]>)                                                                               

There are a few issues here that should be addressed:

  • The arena numbers should be numeric(1) or numeric(n_age_groups)
  • Risk can be larger than 1
  • It should be more clear, how to make your own unit using this template. What are the numbers you should put in?
@RasmusSkytte RasmusSkytte added the documentation Improvements or additions to documentation label Nov 9, 2023
@RasmusSkytte RasmusSkytte added good first issue Good for newcomers backlog This will be worked on in the future labels Nov 9, 2023
@RasmusSkytte RasmusSkytte added this to the v0.2 milestone Nov 10, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
backlog This will be worked on in the future documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

2 participants