HoshinoKoji/jsPsych
1
0
Fork 0
mirror of https://github.com/jspsych/jsPsych.git synced 2025-05-10 11:10:54 +00:00
Code Issues Actions Packages Projects Releases Wiki Activity

add getCitations() doc in jspsych.md under reference; delete extra changeset

Browse Source
This commit is contained in:
Cherrie Chang 2024-12-18 17:29:34 -05:00
parent 3948fdc0ac
commit 4834c9690a
2 changed files with 28 additions and 62 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

62
.changeset/rotten-spiders-march.md
View File

@ -1,62 +0,0 @@
---
"@jspsych/plugin-serial-reaction-time-mouse": minor
"@jspsych/plugin-canvas-keyboard-response": minor
"@jspsych/plugin-audio-keyboard-response": minor
"@jspsych/plugin-image-keyboard-response": minor
"@jspsych/plugin-video-keyboard-response": minor
"@jspsych/plugin-canvas-button-response": minor
"@jspsych/plugin-canvas-slider-response": minor
"@jspsych/plugin-html-keyboard-response": minor
"@jspsych/plugin-audio-button-response": minor
"@jspsych/plugin-audio-slider-response": minor
"@jspsych/plugin-image-button-response": minor
"@jspsych/plugin-image-slider-response": minor
"@jspsych/plugin-initialize-microphone": minor
"@jspsych/plugin-video-button-response": minor
"@jspsych/plugin-video-slider-response": minor
"@jspsych/plugin-categorize-animation": minor
"@jspsych/plugin-html-button-response": minor
"@jspsych/plugin-html-slider-response": minor
"@jspsych/plugin-same-different-image": minor
"@jspsych/plugin-serial-reaction-time": minor
"@jspsych/plugin-visual-search-circle": minor
"@jspsych/plugin-webgazer-init-camera": minor
"@jspsych/plugin-html-audio-response": minor
"@jspsych/plugin-html-video-response": minor
"@jspsych/plugin-same-different-html": minor
"@jspsych/plugin-survey-multi-choice": minor
"@jspsych/plugin-survey-multi-select": minor
"@jspsych/plugin-webgazer-calibrate": minor
"@jspsych/extension-mouse-tracking": minor
"@jspsych/plugin-initialize-camera": minor
"@jspsych/plugin-webgazer-validate": minor
"@jspsych/plugin-categorize-image": minor
"@jspsych/plugin-survey-html-form": minor
"@jspsych/plugin-virtual-chinrest": minor
"@jspsych/extension-record-video": minor
"@jspsych/plugin-categorize-html": minor
"@jspsych/plugin-reconstruction": minor
"@jspsych/plugin-browser-check": minor
"@jspsych/plugin-call-function": minor
"@jspsych/plugin-external-html": minor
"@jspsych/plugin-mirror-camera": minor
"@jspsych/plugin-survey-likert": minor
"@jspsych/plugin-instructions": minor
"@jspsych/extension-webgazer": minor
"@jspsych/plugin-survey-text": minor
"@jspsych/plugin-fullscreen": minor
"@jspsych/plugin-animation": minor
"@jspsych/plugin-free-sort": minor
"@jspsych/plugin-iat-image": minor
"@jspsych/plugin-sketchpad": minor
"@jspsych/plugin-iat-html": minor
"@jspsych/plugin-maxdiff": minor
"@jspsych/plugin-preload": minor
"@jspsych/plugin-resize": minor
"@jspsych/plugin-survey": minor
"@jspsych/plugin-cloze": minor
"jspsych": minor
"@jspsych/config": minor
---
Added citation tool to generate citations from input array of plugins/extensions using .cff files

28
docs/reference/jspsych.md
View File

@ -346,6 +346,34 @@ This method tells jsPsych that the current trial is over. It is used in all of t
jsPsych.finishTrial({correct_response: true}); jsPsych.finishTrial({correct_response: true});
``` ```
---
## jsPsych.getCitations
```javascript
jsPsych.getCitations(plugins, format)
```
### Parameters
| Parameter | Type | Description |
| --------- | ------ | ---------------------------------------------------- |
| plugins | array | Array containing list of plugins/extensions by name. |
| format | string | Output citation format ("apa" | "bibtex") |
### Return value
String of generated citations in the specified format for the jsPsych library, followed by that for each input plugin/extension, separated with a "\n" character.
### Description
Get citations in a specified format for the jsPsych library and input list of plugins/extensions, usually those used within an experiment.
### Example
```javascript
// in browser console
jsPsych.getCitations() // prints citation for jsPsych library in APA format
jsPsych.getCitations([TestPlugin], "bibtex") // prints citation for jsPsych library and TestPlugin (if different) in BibTex format
```
--- ---
## jsPsych.getCurrentTrial ## jsPsych.getCurrentTrial