Scoping the R package

[bleonar5]

Psych-DS R Package MVP Scope

Overview

Our next goal is to create an R package offering both programmatic API and GUI interfaces. This document outlines the MVP scope and implementation plan.

Core Workflows & Features

1. Dataset Conversion & Metadata Generation

• Auto-conversion Pipeline

  • Input: Raw psychological CSV data files (as well as other auxilliary files)
  • Output: Skeletal Psych-DS compliant dataset
  • Automatic metadata generation
  • Stretch goal: rules for how to map arbitrary CSV

• Data Dictionary Wizard

  • Interactive variable documentation
  • Automated type inference
  • Standardized terminology mapping
  • Export to machine-readable formats (JSON-LD PropertyValue objects)

2. Data Management Features

• Dataset Validation

  • Schema compliance checking
  • Troubleshooting feedback on errors

• OSF Uploading

  • Use OSF API to upload complete and validated datasets to public repo
  • Gate the upload function so that only validated and unchanged datasets can go through

3. GUI Dashboard

• Conversion Interface

  • Drag-and-drop file import
  • Boxes for various auxilliary folders

• Dataset Explorer

  • Visual dataset preview
  • Search filter options for keyword and columns

• Data dictionary wizard

  • Consolidate and simplify functionality from doomlab ddcreator to fit on one page

• Validation Interface

  • Replicate original validation interface faithfully

• Upload Interface

  • Features for logging in and creating OSF account (hopefully exists already)
  • Upload and reupload (possibly download?) OSF repositories

Implementation Strategy

Phase 1: Core API

1. Basic validation functions
2. OSF upload wrappers
3. Any necessary backend functions for GUI

Phase 2: GUI Development

1. Shiny-based dashboard
2. Interactive wizards for generating metadata and file systems
3. Validation view
4. OSF Export utilities

Integration Considerations

OSF Integration

• File import/export
• Version control support (optional)

CRAN Requirements

• Documentation coverage
• Test suite
• Platform compatibility
• Size constraints
• License compliance

Mockup Pages for GUI