Skip to content

ddi-developers/nectar-publisher

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

94 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

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

Implementation and status for Nectar Publisher 1.0

Dataset inputs

  • CSV / TSV - files
  • Excel / ODS spreadsheet
  • SPSS (via OpenCPU)
  • SPSS (local in browser parser)

Metadata imports

  • DDI-C 2.5 variable documentation
  • DDI-L 3.3 variable documentation

Output

  • Metadata
    • DDI-C 2.5 XML
    • DDI-L 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

Build instructions

No build tools required.
Nectar Publisher aims for easy development & deployment without the need for any special tools or processes.
Open any source file; edit, save see changes in the browser KISS Principle.

License

MIT