From 4e5e40dd214ea0089283f10ab6f49b479fda57a3 Mon Sep 17 00:00:00 2001 From: vzhang03 Date: Mon, 23 Sep 2024 11:04:19 -0400 Subject: [PATCH 01/10] Line edit to fix grammar --- packages/metadata/src/PluginCache.ts | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/packages/metadata/src/PluginCache.ts b/packages/metadata/src/PluginCache.ts index b4fac67..abc598b 100644 --- a/packages/metadata/src/PluginCache.ts +++ b/packages/metadata/src/PluginCache.ts @@ -126,7 +126,7 @@ export class PluginCache { pluginType, "with error", error, - "Note: if you are using a plugin not supported the main JsPsych branch this will always fail." + "Note: if you are using a plugin not supported in the main JsPsych branch this will always fail." ); return undefined; } From a0a1e8e1bed68e45a219d7ac882553b9f561886c Mon Sep 17 00:00:00 2001 From: vzhang03 Date: Sun, 20 Oct 2024 23:47:02 -0400 Subject: [PATCH 02/10] User documentation outlining --- README.md | 19 +++++++- dev/metadata-timeline-variables.html | 4 +- package-lock.json | 66 +++++++++++++++++++++++++--- packages/metadata/package.json | 4 +- 4 files changed, 82 insertions(+), 11 deletions(-) diff --git a/README.md b/README.md index bc55acb..ce520b5 100644 --- a/README.md +++ b/README.md @@ -1,2 +1,17 @@ -# metadata -Library and CLI tool to generate Psych-DS compliant metadata for jsPsych experiments +# Psych-DS and metadata + +## What is Psych-DS and metadata? + +Psych-DS is a template data schema to standardize the representation of data files for common Psychology and Cognitive Science experiments. This representation aims to help facilate data sharing by making data more understandable using common structures and metadata files that describe the data. Metadata files describe the data and including relevant information about the types of variables present as well as what each file represents. + +## How does it relate to Jspsych? + +JsPsych is one software among many to begin implementing this data standard and has many different tools to generate metadata automatically from data files. + +# Creating metadata and Psych-DS directories + +## How do I create a metadata file and organize my project according to Psych-DS? + +There are many different ways to generate metadata. Each tool has it's own pros and cons, + +# Developer Roadmap diff --git a/dev/metadata-timeline-variables.html b/dev/metadata-timeline-variables.html index 5b6f10a..75de424 100644 --- a/dev/metadata-timeline-variables.html +++ b/dev/metadata-timeline-variables.html @@ -8,8 +8,8 @@ - - + +