Skip to content

Suggestions for improving the vignettes #35

@reikookamoto

Description

@reikookamoto
  • Adopt conventions when writing variable, function, and package names in addition to file paths
  • Clarify terminology
    • What is the difference between a variable name and a label, and how does this relate to other programming languages like Stata
    • tester1 and tester2 should be referred to as datasets rather than databases; the latter usually refers to an organized collection of data
  • Clarify the order in which a new user should read the vignettes
  • Proofread for grammatical and spelling errors
  • Reduce redundancy in writing (i.e., how_to_use_recodeflow_with_your_data.Rmd contains the same information as variable_details.Rmd and variables_sheet.Rmd)
  • Make sure each vignette shows a particular workflow from start to finish (e.g., how to organize a variables sheet by walking through a sample, how to fill in a details sheet, how to call the main function to address common tasks)
  • DT package (used across several files) is in maintenance-only mode so consider using another package for making tables

Questions that crossed my mind

  • Can fields be left blank in the sheets?
  • Are there data type checks that confirm that the data in the sheets are of the correct data type?
    • E.g., we wouldn't expect numeric data in the label column of the variables sheet
  • Under what circumstances does the details sheet get updated after calling rec_with_table()?

Metadata

Metadata

Assignees

No one assigned

    Labels

    No labels
    No labels

    Type

    No type

    Projects

    No projects

    Milestone

    No milestone

    Relationships

    None yet

    Development

    No branches or pull requests

    Issue actions