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 README #28

Open
lwarode opened this issue Aug 9, 2022 · 3 comments
Open

create README #28

lwarode opened this issue Aug 9, 2022 · 3 comments

Comments

@lwarode
Copy link
Collaborator

lwarode commented Aug 9, 2022

  • README file should contain basic information of the package and deliver a low level introduction
  • some elements might be a duplicate in vignette or vice versa, but rather focus on basic elements of package and don't show too complex workflow mechanisms
  • implement table that is showing all functions/methods and highlight which data tables and variables are suitable for operation
@lwarode
Copy link
Collaborator Author

lwarode commented Aug 10, 2022

  • show how to set up docker configuration for R6 object or show in vignette? @FloLimebit what do you think? I would suggest to include it (at least) briefly in the README to be as inclusive as possible for non-technical and rather political (science) target audience

@lwarode
Copy link
Collaborator Author

lwarode commented Aug 10, 2022

  • mention differentiation of get_ functions: systematic deviation in input arguments (some are just working with specific data tables and deliver a data frame as output, e.g. get_profession_groups, others like get_state are designed to work in dplyr::mutate calls

@lwarode
Copy link
Collaborator Author

lwarode commented Sep 9, 2022

  • 3 options: show just functions (so far), object & methods, or both

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