Nectar Publisher 🐝

Document your tabular datasets and create codebooks and machine actionable metadata using DDI.

Note

Nectar Publisher is under early development and might not work correctly

Run the application

• On GitHub pages: https://ddi-developers.github.io/nectar-publisher
• Localy by download and extracting this zip-file (works offline when downloaded)

Implementation and status for Nectar Publisher 1.0

Dataset inputs

• CSV / TSV - files
• Excel / ODS spreadsheet
• SPSS, Stata, SAS (local in browser via WebR with DDIwR)

Metadata imports

• DDI-Codebook 2.5 variable documentation
• DDI-Lifecycle 3.3 variable documentation

Output

• Metadata
  • DDI-Codebook 2.5 XML
  • DDI-Lifecycle 3.3 XML
  • DDI-CDI JSON-LD
• Codebook
  • Markdown
  • Html
  • Pdf

Plugin system to push metadata & data to external repository

• Define a interface with methods for export
• Example implementation for a repository

Column based listing with variables in focus

• Responsive layout
• User interviews and requirements for efficent interface
• Layout design

Metadata

Data file documentation

• File metadata (extracted from file)
  • filename
  • delimiter
  • mimeType
  • size (bytes)
  • checksum (sha256)
• Variable metadata (autodetected & input)
  • Id (column header name if exist, fallback to column number)
  • Column number (auto generated on file import)
  • Name (set to column header if existing)
  • Label
  • Description
  • DataType
  • UnitCode
  • Min/Max value
  • CollectionMethod
  • ResponseDomain
    • Text
    • Numeric
    • Datetime
    • Code
      • value
      • label
      • isMissingValue
      • frequency

Requirements

• Node.js 24 or newer
• npm 11 or newer (included with Node.js 24)

Build instructions

1. Colone this repository
2. Install dependecies with npm install
3. Build with npm run build

Run locally for development

1. run npm install
2. run npm run dev
3. Open http://localhost:5173 in your browser

Run tests

npm run test

License

MIT