1"use strict";(self.webpackChunkdocs_website=self.webpackChunkdocs_website||[]).push([["2895"],{5015(e,t,s){s.r(t),s.d(t,{metadata:()=>d,default:()=>l,frontMatter:()=>n,contentTitle:()=>a,toc:()=>o,assets:()=>c});var d=JSON.parse('{"id":"typedoc/interfaces/StudyMetadata","title":"StudyMetadata","description":"Defined in47","source":"@site/versioned_docs/version-v2.1.1/typedoc/interfaces/StudyMetadata.md","sourceDirName":"typedoc/interfaces","slug":"/typedoc/interfaces/StudyMetadata","permalink":"/docs/v2.1.1/typedoc/interfaces/StudyMetadata","draft":false,"unlisted":false,"tags":[],"version":"v2.1.1","lastUpdatedAt":1788969589000,"frontMatter":{},"sidebar":"reference","previous":{"title":"StudyConfig","permalink":"/docs/v2.1.1/typedoc/interfaces/StudyConfig"},"next":{"title":"UIConfig","permalink":"/docs/v2.1.1/typedoc/interfaces/UIConfig"}}'),r=s(74848),i=s(28453);let n={},a="StudyMetadata",c={},o=[{value:"Properties",id:"properties",level:2}];function h(e){let t={a:"a",code:"code",h1:"h1",h2:"h2",header:"header",p:"p",pre:"pre",table:"table",tbody:"tbody",td:"td",th:"th",thead:"thead",tr:"tr",...(0,i.R)(),...e.components};return(0,r.jsxs)(r.Fragment,{children:[(0,r.jsx)(t.header,{children:(0,r.jsx)(t.h1,{id:"studymetadata",children:"StudyMetadata"})}),"\n",(0,r.jsxs)(t.p,{children:["Defined in: ",(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L47",children:"parser/types.ts:47"})]}),"\n",(0,r.jsx)(t.p,{children:"The StudyMetadata is used to describe certain properties of a study.\nSome of this data is displayed on the landing page when running the app, such as the title and description.\nBelow is an example of a StudyMetadata entry in your study configuration file:"}),"\n",(0,r.jsx)(t.pre,{children:(0,r.jsx)(t.code,{className:"language-js",children:'"studyMetadata" : {\n "title": "My New Study",\n "version": "pilot",\n "authors": [\n "Jane Doe",\n "John Doe"\n ],\n "date": "2024-04-01",\n "description": "This study is meant to test your ability.",\n "organizations": [\n "The reVISit Team",\n "The Other Team"\n ]\n}\n'})}),"\n",(0,r.jsx)(t.h2,{id:"properties",children:"Properties"}),"\n",(0,r.jsxs)(t.table,{children:[(0,r.jsx)(t.thead,{children:(0,r.jsxs)(t.tr,{children:[(0,r.jsx)(t.th,{children:"Property"}),(0,r.jsx)(t.th,{children:"Type"}),(0,r.jsx)(t.th,{children:"Description"}),(0,r.jsx)(t.th,{children:"Defined in"})]})}),(0,r.jsxs)(t.tbody,{children:[(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"authors"})," ",(0,r.jsx)(t.code,{children:"authors"})]}),(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.code,{children:"string"}),"[]"]}),(0,r.jsx)(t.td,{children:"The authors of your study."}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L53",children:"parser/types.ts:53"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"date"})," ",(0,r.jsx)(t.code,{children:"date"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"string"})}),(0,r.jsx)(t.td,{children:"The date of your study, may be useful for the researcher."}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L55",children:"parser/types.ts:55"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"description"})," ",(0,r.jsx)(t.code,{children:"description"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"string"})}),(0,r.jsx)(t.td,{children:"The description of your study, shown on the landing page."}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L57",children:"parser/types.ts:57"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"organizations"})," ",(0,r.jsx)(t.code,{children:"organizations"})]}),(0,r.jsxs)(t.td,{children:[(0,r.jsx)(t.code,{children:"string"}),"[]"]}),(0,r.jsx)(t.td,{children:"The organizations that are associated with your study."}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L59",children:"parser/types.ts:59"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"title"})," ",(0,r.jsx)(t.code,{children:"title"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"string"})}),(0,r.jsx)(t.td,{children:"The title of your study, shown on the landing page."}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L49",children:"parser/types.ts:49"})})]}),(0,r.jsxs)(t.tr,{children:[(0,r.jsxs)(t.td,{children:[(0,r.jsx)("a",{id:"version"})," ",(0,r.jsx)(t.code,{children:"version"})]}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.code,{children:"string"})}),(0,r.jsx)(t.td,{children:"The version of your study. When you change a configuration file after a study has already been distributed to participants, you can change the version number so that the participants who see this new configuration file can be identified."}),(0,r.jsx)(t.td,{children:(0,r.jsx)(t.a,{href:"https://github.com/revisit-studies/study/blob/2e617a552035dd6d22a4f8cba7e0d8ac40275f33/src/parser/types.ts#L51",children:"parser/types.ts:51"})})]})]})]})]})}function l(e={}){let{wrapper:t}={...(0,i.R)(),...e.components};return t?(0,r.jsx)(t,{...e,children:(0,r.jsx)(h,{...e})}):h(e)}},28453(e,t,s){s.d(t,{R:()=>n,x:()=>a});var d=s(96540);let r={},i=d.createContext(r);function n(e){let t=d.useContext(i);return d.useMemo(function(){return"function"==typeof e?e(t):{...t,...e}},[t,e])}function a(e){let t;return t=e.disableParentContext?"function"==typeof e.components?e.components(r):e.components||r:n(e.components),d.createElement(i.Provider,{value:t},e.children)}}}]);
Line numbers count LF bytes from the start of the resource, as the search results do. Vendor segments are library code the classifier recognised; they are stored but not indexed. Bytes are shown as Latin1 characters, one per byte.