0.20.0 • Published 1 year ago

applet-schema-builder v0.20.0

Weekly downloads
157
License
SEE LICENSE in LI...
Repository
github
Last release
1 year ago

Applet Schema Builder

AccessKey

Visual user interface used to design, edit, and generate ReproSchema protocols. Written in Vue, hosted on GitHub, and distributed with NPM.

Usage

Install dependency

npm install applet-schema-builder
<template>
  <AppletSchemaBuilder
    exportButton
    @uploadProtocol="onUploadApplet"
  />
</template>

<script>
import Components from 'applet-schema-builder';

export default {
  name: 'My-App',
  components: {
    ...Components,
  },
  methods: {
    onUploadApplet(newApplet) {
        console.log('new applet', newApplet);
    }
  },
}
</script>

Project Development setup

npm install

Compiles and hot-reloads for development

npm run serve

Compiles and minifies for distribution

npm run build-bundle

Publish to npm (requires authentication)

npm run publish

Lint files

npm run lint

ReproSchema Documentation

All applets, activities, and items are specified text files in a JSON-LD format (JavaScript Object Notation for Linked Data) and each applet, activity, and item provides unique and persistent identifiers.

  • At the item level, the elements of an individual assessment, like the questions in a questionnaire
  • At the activity level, an individual assessment that contains a set of items, like for example a whole questionnaire with a several questions.
  • At the applet level, a collection of activities performed by a participant, e.g a set of questionnaires used in a study.

Applet

A representation of a study which comprises one or more assessments.

NameDescriptionURL
addPropertiesAn array of objects to describe the various properties added to an applet.
landingPageAn element (by URL) to point to the applet readme or landing page.
orderAn ordered list to describe the order in which the items of an assessment or applet appear in the user interface.
aboutThe subject matter of the applet.
descriptionA description of the applet.
imageAn image of the item. This can be a URL or a fully described ImageObject.
schemaVersionIndicates (by URL or string) a particular version of a schema used in some CreativeWork. For example, a document could declare a schemaVersion using an URL such as http://schema.org/version/2.0/ if precise indication of schema version was required by some application.
versionThe version of the CreativeWork embodied by a specified resource.
altLabelThe alternate label.http://www.w3.org/2004/02/skos/core#altLabel
prefLabelThe preferred label.http://www.w3.org/2004/02/skos/core#prefLabel

Activity

An assessment in an applet.

NameDescriptionURL
addPropertiesAn array of objects to describe the various properties added to assessments.
orderAn ordered list to describe the order in which the items of an assessment or applet appear in the user interface.
preambleThe preamble for an assessment
aboutThe subject matter of the activity.
descriptionA description of the activity.
imageAn image of the item. This can be a URL or a fully described ImageObject.
schemaVersionIndicates (by URL or string) a particular version of a schema used in some CreativeWork. For example, a document could declare a schemaVersion using an URL such as http://schema.org/version/2.0/ if precise indication of schema version was required by some application.
versionThe version of the CreativeWork embodied by a specified resource.
altLabelThe alternate label.http://www.w3.org/2004/02/skos/core#altLabel
prefLabelThe preferred label.http://www.w3.org/2004/02/skos/core#prefLabel

Item

An item in an assessment

NameDescriptionURL
inputTypeAn element to describe the input type of a item.
responseOptionsAn element (object or by URL)to describe the properties of response of the item.
aboutThe subject matter of the item.
descriptionA description of the item.
imageAn image of the item. This can be a URL or a fully described ImageObject.
isPartOfIndicates an item or CreativeWork that this item, or CreativeWork (in some sense), is part of.
questionA sub property of object. A question.
schemaVersionIndicates (by URL or string) a particular version of a schema used in some CreativeWork. For example, a document could declare a schemaVersion using an URL such as http://schema.org/version/2.0/ if precise indication of schema version was required by some application.
versionThe version of the CreativeWork embodied by a specified resource.
altLabelThe alternate label.http://www.w3.org/2004/02/skos/core#altLabel
prefLabelThe preferred label.http://www.w3.org/2004/02/skos/core#prefLabel

AdditionalProperty

An object to describe the various properties added to assessments and fields

NameDescriptionURL
allowAn array of items indicating properties allowed on an activity or applet
isAboutA pointer to the node describing the item.
isVisAn element to describe (by boolean or conditional statement) visibility conditions of items in an assessment.
variableNameThe name used to represent an item.
valueRequiredWhether the property must be filled in to complete the action. Default is false.
prefLabelThe preferred label.http://www.w3.org/2004/02/skos/core#prefLabel

ResponseOption

An element (object or by URL)to describe the properties of response of the Field item.

NameDescriptionURL
choicesAn array to list the available options for response of the Field item.
multipleChoiceIndicates (by bool) if response for the Field item has one or more answer.
valueTypeThe type of the response of an item. For example, string, integer, etc.http://schema.repronim.org/valueType
maxValueThe upper value of some characteristic or property.
minValueThe lower value of some characteristic or property.

Choice

An object to describe a response option.

NameDescriptionURL
valueThe value for each option in choices or in additionalNotesObj
imageAn image of the item. This can be a URL or a fully described ImageObject.http://schema.repronim.org/image
nameThe name of the item.

ComputeSpecification

An object to define computations in an activity or applet.

NameDescriptionURI
jsExpressionA JavaScript expression to compute a score from other variables.http://schema.repronim.org/jsExpression
variableNameThe name used to represent an item.http://schema.repronim.org/variableName

MessageSpecification

An object to define messages in an activity or applet.

NameDescriptionURI
jsExpressionA JavaScript expression to compute a score from other variables.http://schema.repronim.org/jsExpression
messageThe message to be conditionally displayed for an item.

SliderOption

New options for slider items.

NameDescriptionURI
continousSliderIndicates (by bool) if a slider wiget (is smooth or) is not constrained to predetermined answers.http://schema.repronim.org/continousSlider
showTickMarksAn option (boolean) to turn on/off the tick marks in a slider item.

CorrectAnswer

A given answer in a free text item.

NameDescriptionURI
correctAnswerIndicates (by string) a correct answer in a free text item. In order to move to the next item, user should answer the question correctly

SubScaleScoring

Represents list of sub scales in an activity and applet

NameDescriptionURI
lookupTableArray of objects which contains tScore, rawScore, age and sex.http://schema.repronim.org/lookupTable
tScoreA score which replaces rawScore if a name and sex in table are the same with user's
rawScoreA score that is calculated by adding scores for items within cumulative scoring
ageExpected user's age in table
sexExpected user's sex in table

TokenPrize

NameDescriptionURI
isPrizeIndicates (by bool) if it is a TokenPrize Activity.http://schema.repronim.org/isPrize
enableNegativeTokensIndicates (by bool) if it is enabled to use negative tokens.

StackedItem

NameDescriptionURI
itemOptionsRepresents the value, score and alert texts for stacked item.http://schema.repronim.org/isPrize
itemListA list of items (value, score, and alert)
scoresAn array which evaluates raw scores of each subscales

OptionalText

An optional text field in an item.

NameDescriptionURI
isOptionalTextAn optional textbox (like a comment) that can be added in all types of itemshttp://schema.repronim.org/isOptionalText
isOptionalTextRequiredIndicates (by bool) if the optional textbox is required in an item
0.20.1-alpha

1 year ago

0.18.9-alpha

1 year ago

0.19.1-alpha

1 year ago

0.20.0

1 year ago

0.18.41-alpha

2 years ago

0.18.9-beta

1 year ago

0.20.0-alpha

1 year ago

0.18.9

1 year ago

0.18.51-alpha

2 years ago

0.18.75

1 year ago

0.18.71-alpha

1 year ago

0.18.3

2 years ago

0.18.4

1 year ago

0.18.5

1 year ago

0.18.6

1 year ago

0.18.8

1 year ago

0.18.5-alpha

1 year ago

0.19.0-alpha

1 year ago

0.18.74-alpha

1 year ago

0.20.2-alpha

1 year ago

0.18.10

1 year ago

0.18.61-alpha

2 years ago

0.19.0

1 year ago

0.18.73-alpha

1 year ago

0.18.10-alpha

1 year ago

0.18.72-alpha

1 year ago

0.18.7-alpha

1 year ago

0.20.0-beta

1 year ago

0.20.1-beta

1 year ago

0.20.2-beta

1 year ago

0.18.10-beta

1 year ago

0.18.42

2 years ago

0.18.33-alpha

2 years ago

0.18.3-alpha

2 years ago

0.18.32-alpha

2 years ago

0.18.31-alpha

2 years ago

0.18.1

2 years ago

0.18.2

2 years ago

0.18.0

2 years ago

0.18.33-beta

2 years ago

0.17.0

2 years ago

0.17.1

2 years ago

0.16.0

2 years ago

0.15.0

2 years ago

0.13.0

2 years ago

0.13.1

2 years ago

0.12.0

2 years ago

0.12.1

2 years ago

0.14.0

2 years ago

0.12.2

2 years ago

0.11.0

2 years ago

0.10.0

2 years ago

0.9.2

3 years ago

0.9.1

3 years ago

0.8.0

3 years ago

0.7.3

3 years ago

0.7.2

3 years ago

0.7.1

3 years ago

0.7.0

3 years ago

0.6.9

3 years ago

0.6.2

3 years ago

0.6.0

3 years ago

0.3.38

3 years ago

0.3.33

3 years ago

0.3.32

3 years ago

0.3.29

3 years ago

0.3.27

3 years ago

0.3.24

3 years ago

0.3.22

3 years ago

0.3.20

3 years ago

0.3.17

3 years ago

0.3.14

3 years ago

0.3.13

3 years ago

0.3.11

3 years ago

0.3.10

3 years ago

0.3.7

3 years ago

0.3.6

3 years ago

0.3.5

3 years ago

0.3.4

3 years ago

0.3.3

4 years ago

0.0.35

4 years ago

0.2.19

4 years ago

0.2.18

4 years ago

0.3.0

4 years ago

0.2.17

4 years ago

0.2.16

4 years ago

0.2.15

4 years ago

0.2.14

4 years ago

0.2.13

4 years ago

0.2.11

4 years ago

0.3.2

4 years ago

0.3.1

4 years ago

0.2.9

4 years ago

0.2.8

4 years ago

0.2.6

4 years ago

0.2.5

4 years ago

0.2.4

4 years ago

0.2.3

4 years ago

0.2.2

4 years ago

0.1.51

4 years ago

0.1.33

4 years ago

0.2.1

4 years ago

0.2.0

4 years ago

0.1.32

4 years ago

0.1.30

4 years ago

0.1.31

4 years ago

0.1.29

4 years ago

0.1.25

4 years ago

0.1.26

4 years ago

0.1.27

4 years ago

0.1.28

4 years ago

0.1.24

4 years ago

0.1.23

4 years ago

0.1.22

4 years ago

0.1.19

4 years ago

1.1.21

4 years ago

0.1.21

4 years ago

0.1.20

4 years ago

1.2.21

4 years ago