diff --git a/NAMESPACE b/NAMESPACE
index b0dc707..464b15a 100644
--- a/NAMESPACE
+++ b/NAMESPACE
@@ -2,4 +2,5 @@ import(jaspBase)
export(addOne)
export(processData)
export(processTable)
-export(parabola)
\ No newline at end of file
+export(parabola)
+export(interfaceExample)
\ No newline at end of file
diff --git a/R/examples.R b/R/examples.R
index 4158b12..2bf3142 100644
--- a/R/examples.R
+++ b/R/examples.R
@@ -1,3 +1,51 @@
+interfaceExample <- function(jaspResults, dataset, options) {
+ # Just show the options as they are understood the R backend
+ jaspResults[["explanation"]] <- createJaspHtml(title = "User inputs, returned as html",
+ text = sprintf("Here we show, for pedagogical purposes, the user inputs as they are understood by the R backend."))
+
+ jaspResults[["logicals"]] <- createJaspHtml(
+ title = "Logical controls",
+ text = sprintf("The tick mark is set to: %s
+ The radio buttons are set to: %s",
+ as.character(options$my_tick_mark), # These variables are defined in .inst/qml/Interface.qml
+ as.character(options$radio_buttons)) # Notice we have to be careful with the data type
+ )
+
+ jaspResults[["others"]] <- createJaspHtml(
+ title = "Other controls",
+ text = sprintf("The chosen dropdown element is: %s
+ The slider value is: %s",
+ as.character(options$my_dropdown),
+ as.character(options$my_slider))
+ )
+
+ jaspResults[["keyboard"]] <- createJaspHtml(
+ title = "Keyboard controls",
+ text = sprintf("The integer is set to: %s
+ The double is set to: %s
+ The percentage is set to: %s
+ The confidence interval is set to: %s
+ The text box is set to: %s ",
+ as.character(options$my_integer),
+ as.character(options$my_double),
+ as.character(options$my_percent),
+ as.character(options$my_ci),
+ options$my_text) # No data-type conversion needed for text
+ )
+
+ jaspResults[["developers"]] <- createJaspHtml(
+ title = "Note for developers",
+ text = sprintf("Potential developers will find it useful to inspect the following files:
+ ")
+ )
+
+ return()
+}
+
addOne <- function(jaspResults, dataset, options) {
result <- as.character(options$my_number + 1) # options$my_number comes from the menu created by inst/qml/integer.qml
diff --git a/README.md b/README.md
index f2306a2..7b5d4e9 100644
--- a/README.md
+++ b/README.md
@@ -1,15 +1,25 @@
# jaspModuleTemplate
-This template repository is a starting point for developing a new module for JASP.
-It contains the necessary files and structure, plus a numbers of examples to get started.
+This template repository contains example functionality, which makes it an excellent starting point for developing a new JASP module.
+It contains the necessary files and structure, plus a numbers of examples to get started and to understand JASP's internals.
## How to use this repository
-Fork this template repository to your own GitHub account to start developing your module.
-You can then clone the repository to your local machine and start developing your module.
+1. Fork this template repository to your own GitHub account
+2. Clone it to your machine
+3. Open JASP and add it as a development module
-The repository contains example functionality.
-Feel free to reuse and adapt the examples to your needs.
+### For newcomers
+
+It is very illuminating to take a look at our examples **and** at the files that generate them.
+
+For instance, the image below shows the different menus for the _"Using the interface"_ analysis, together with the files that generate them:
+
+
+
+### For contributors
+
+Feel free to reuse and adapt to your needs.
Feel also free to remove the ones you don't need.
## Contributing back new module to JASP
diff --git a/inst/Description.qml b/inst/Description.qml
index 58ae563..cc9aad9 100644
--- a/inst/Description.qml
+++ b/inst/Description.qml
@@ -15,6 +15,27 @@ Description
preloadData: true
requiresData: true
+ GroupTitle
+ {
+ title: qsTr("Basic interactivity")
+ }
+
+ Analysis
+ {
+ title: qsTr("Using the interface") // Title for window
+ menu: qsTr("Using the interface") // Title for ribbon
+ func: "interfaceExample" // Function to be called
+ qml: "Interface.qml" // Design input window
+ requiresData: false // Allow to run even without data
+ }
+
+ Analysis
+ {
+ title: qsTr("Loading data")
+ menu: qsTr("Loading data")
+ func: "processData"
+ qml: "Data.qml"
+ }
GroupTitle
{
@@ -30,14 +51,6 @@ Description
requiresData: false // Allow to run even without data
}
- Analysis
- {
- title: qsTr("Load data")
- menu: qsTr("Load data")
- func: "processData"
- qml: "Data.qml"
- }
-
Analysis
{
title: qsTr("Tabular results")
diff --git a/inst/img/JASP.png b/inst/img/JASP.png
new file mode 100644
index 0000000..c0ec774
Binary files /dev/null and b/inst/img/JASP.png differ
diff --git a/inst/img/JASP.png.svg b/inst/img/JASP.png.svg
new file mode 100644
index 0000000..16a7298
--- /dev/null
+++ b/inst/img/JASP.png.svg
@@ -0,0 +1,8660 @@
+
+
+
+
+
+
+
+ ./inst/Description.qml ./inst/qml/Interface.qml ./R/examples.R
+
diff --git a/inst/qml/Interface.qml b/inst/qml/Interface.qml
new file mode 100644
index 0000000..da8154c
--- /dev/null
+++ b/inst/qml/Interface.qml
@@ -0,0 +1,188 @@
+//
+// Copyright (C) 2013-2018 University of Amsterdam
+//
+// This program is free software: you can redistribute it and/or modify
+// it under the terms of the GNU Affero General Public License as
+// published by the Free Software Foundation, either version 3 of the
+// License, or (at your option) any later version.
+//
+// This program is distributed in the hope that it will be useful,
+// but WITHOUT ANY WARRANTY; without even the implied warranty of
+// MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the
+// GNU Affero General Public License for more details.
+//
+// You should have received a copy of the GNU Affero General Public
+// License along with this program. If not, see
+//