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

Possibly move roxygen functionality into separate package from decoration functionality #8

Open
strazto opened this issue Aug 5, 2020 · 0 comments

Comments

@strazto
Copy link
Owner

strazto commented Aug 5, 2020

Though these two components of {mandrake} have reasonably high cohesion, they have distinctly different applications:

  • roxygen components:

    • Provides a common workflow within a package for documenting columns in a way that's consistent and cross referencable
    • Produces data that can be consumed by:
      • the decorators
      • packages inheriting columns from this package
  • decoration components

    • consumes data produced by roxygen component
    • enriches visNetwork graph, and is tightly integrated with {drake}.
  • Projects / packages that produce drake::drake_plans() will:

    • Directly use the decoration components, while
    • consuming data produced by packages that use the roxygen components.
      • the project may use the roxygen components, and dogfood its own colspecs, but not necessarily
  • packages that provide data analysis/transformation/manipulation functions will:

    • Directly use the roxygen components
      • Potentially never use the decoration components

The shared components are the API for data consumption / production - the colspec format, and the caching / consumption mechanism thereof.

Given that decoration relies on roxygen, this mechanism should probably belong to the roxygen component.

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