Skip to content

Issue #4: Documentation #6

@larnsce

Description

@larnsce

Documentation Review

Checklist:

  • README.Rmd structure and content
    • Installation instructions
    • Usage examples
    • Data description
    • Citation information
  • Function documentation
  • _pkgdown.yml configuration
    • Proper structure
    • Analytics tracking
    • Custom CSS if needed
  • Variable dictionary
    • Complete descriptions
    • Accurate data types

Current Status:

❌ R files lack proper roxygen2 documentation
✅ README.Rmd is comprehensive
⚠️ Vignette in non-standard location
⚠️ Temporary Excel file needs removal

Related Files:

  • README.Rmd
  • R/gdho.R
  • R/gdho_full.R
  • _pkgdown.yml
  • vignettes/articles/examples.Rmd

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