https://github.com/finnishcancerregistry/vame

A principled approach to metadata in R for your dataset.
https://github.com/finnishcancerregistry/vame

data-documentation data-governance data-structures data-validation metadata-management r r-package variable-management variable-metadata

Last synced: over 1 year ago
JSON representation

A principled approach to metadata in R for your dataset.

• Host: GitHub
• URL: https://github.com/finnishcancerregistry/vame
• Owner: FinnishCancerRegistry
• License: other
• Created: 2023-04-11T19:30:54.000Z (over 3 years ago)
• Default Branch: master
• Last Pushed: 2025-02-28T10:16:56.000Z (over 1 year ago)
• Last Synced: 2025-02-28T17:11:50.354Z (over 1 year ago)
• Topics: data-documentation, data-governance, data-structures, data-validation, metadata-management, r, r-package, variable-management, variable-metadata
• Language: R
• Homepage:
• Size: 677 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: NEWS.md
  • License: LICENSE

Awesome Lists containing this project

README

          


# Package `vame`

`vame` makes it simpler to define and make use of metadata pertaining

to one more variables (e.g. a tabular dataset). It implements the

`VariableMetadata` class, which contains the metadata. The various metadata

are accessed using slot functions such as `vm@var_description_get`.

The `VariableMetadata` class is intended for storing metadata for which there

is "one right way". For instance, a variable has one correct description in

text. This philosophy excludes tasks such as creating a manual for a dataset,

which can take many forms.

See the help page `?vame::VariableMetadata` for more information. In

particular see the examples.

[![R-CMD-check](https://github.com/FinnishCancerRegistry/vame/actions/workflows/R-CMD-check.yaml/badge.svg)](https://github.com/FinnishCancerRegistry/vame/actions/workflows/R-CMD-check.yaml)

# Recommended installation

```r

devtools::install_github(

  "FinnishCancerRegistry/vame",

  ref = readline("enter latest tag on github: ")

)

```