Merge eScience Center and JASP versions

.Rbuildignore

@@ -1,3 +1,5 @@
+^renv$
+^renv\.lock$
 ^.*\.Rproj$
 ^\.Rproj\.user$
 ^\.travis\.yml$

.Rprofile

@@ -0,0 +1 @@
+source("renv/activate.R")

.github/workflows/i18nCheck.yml

@@ -1,10 +1,10 @@
-on: 
+on:
   push:
-    paths: ['**.R', '**.qml', '**.po', '**.yml']
- 
+    paths: ["**.R", "**.qml", "**.po", "**.yml"]
+
   pull_request:
-    paths: ['**.R', '**.qml', '**.po', '**.yml']
-  
+    paths: ["**.R", "**.qml", "**.po", "**.yml"]
+
   workflow_dispatch:
 
 name: i18n-check

.github/workflows/translations.yml

@@ -1,7 +1,6 @@
 on:
-  #schedule:
-  #  - cron:  '*/5 * * * *'
-
+  schedule:
+    - cron: "*/5 * * * *"
   workflow_dispatch:
 
 name: generate-translations

.github/workflows/unittests.yml

@@ -1,18 +1,19 @@
 on:
-  push:
-    paths: ['**.R', 'tests/**', '**.Rd', '**.c', '**.cpp', '**.h', '**.hpp', 'DESCRIPTION', 'NAMESPACE', 'MAKEVARS', 'MAKEVARS.win', '**.yml']
-  pull_request:
-    paths: ['**.R', 'tests/**', '**.Rd', '**.c', '**.cpp', '**.h', '**.hpp', 'DESCRIPTION', 'NAMESPACE', 'MAKEVARS', 'MAKEVARS.win']
-  schedule:
-    - cron:  '13 12 * * 1-5'
+  workflow_dispatch:
+
+# on:
+#   push:
+#     paths: ['**.R', 'tests/**', '**.Rd', '**.c', '**.cpp', '**.h', '**.hpp', 'DESCRIPTION', 'NAMESPACE', 'MAKEVARS', 'MAKEVARS.win', '**.yml']
+#   pull_request:
+#     paths: ['**.R', 'tests/**', '**.Rd', '**.c', '**.cpp', '**.h', '**.hpp', 'DESCRIPTION', 'NAMESPACE', 'MAKEVARS', 'MAKEVARS.win']
+#   schedule:
+#     - cron:  '13 12 * * 1-5'
 
 name: unit-tests
 
 jobs:
-
   unit-tests:
-
     uses: jasp-stats/jasp-actions/.github/workflows/unittests.yml@master
     with:
-      needs_JAGS:   false
+      needs_JAGS: false
       needs_igraph: false

DESCRIPTION

@@ -6,7 +6,7 @@ Date: 2020-10-15
 Author: JASP Team
 Website: jasp-stats.org
 Maintainer: JASP Team <info@jasp-stats.org>
-Description: This module offers analyses.
+Description: Example module showing basic functionality. Use it for inspiration when creating your own module.
 License: GPL (>= 2)
 Encoding: UTF-8
 Imports:

NAMESPACE

@@ -1 +1,5 @@
 import(jaspBase)
+export(addOne)
+export(processData)
+export(processTable)
+export(parabola)

R/examples.R

@@ -0,0 +1,56 @@
+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
+
+    jaspResults[["result"]] <- createJaspHtml(text = result,
+                                              title = "This is your result:")
+
+    return()
+}
+
+processData <- function(jaspResults, dataset, options) {
+  # Dataset access
+  # options$ts --maps to--> 't'
+  # dataset[[options$ts]] --maps to--> dataset$t
+  result <- paste(dataset[[options$ts]], collapse = "")
+  jaspResults[["result"]] <- createJaspHtml(text = result,
+                                            title = "This is your result:")
+
+  return()
+}
+
+processTable <- function(jaspResults, dataset, options) {
+  # Prints the inputs as a table
+  stats <- createJaspTable(gettext("Some descriptives"))
+
+  stats$addColumnInfo(name = gettext("times"))
+  stats$addColumnInfo(name = gettext("xs"))
+
+  stats[["times"]] <- dataset[[options$ts]]
+  stats[["xs"]] <- dataset[[options$xs]]
+
+  jaspResults[["stats"]] <- stats
+
+  return()
+}
+
+parabola <- function(jaspResults, dataset, options) {
+  # Analysis
+  f <- function(x) { options$a * x^2 } # Function to be plotted
+  p <- ggplot2::ggplot() +             # Plotting command
+          ggplot2::xlim(-3, 3) +
+          ggplot2::ylim(0, 10) +
+          ggplot2::geom_function(fun = f)
+# add jasp theme
+p <- jaspGraphs::geom_rangeframe() +
+    jaspGraphs::themeJaspRaw()
+  # Aesthetics
+  parabolaPlot <- createJaspPlot(title = gettext("Parabola"),
+                                 width = 160,
+                                 height = 320)
+  parabolaPlot$dependOn(c("a")) # Refresh view whenever a changes
+parabolaPlot$info <- gettext("This figure displays a parabola specified via the `a` option.")
+  jaspResults[["parabolaPlot"]] <- parabolaPlot
+  parabolaPlot$plotObject <- p
+
+  return()
+}

README.md

@@ -1 +1,11 @@
-# jaspModuleTemplate
+# jaspModuleTemplate
+
+This template repository is a starting point for developing a new module for JASP. It contains the necessary files and structure to get you started.
+
+## Forking 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.
+
+## Contributing back new module to JASP
+
+Once you have developed your module, you can contribute it back to JASP by creating a pull request. The JASP team will review your module and provide feedback. Once your module is accepted, a new repo is created in the JASP organization and your module is added to the JASP module repository.

inst/Description.qml

@@ -5,10 +5,55 @@ Description
 {
 	name		: "jaspModule"
 	title		: qsTr("Jasp Module")
-	description	: qsTr("This module offers analyses.")
+	description	: qsTr("Examples for module builders")
 	version		: "0.1"
 	author		: "JASP Team"
 	maintainer	: "JASP Team <info@jasp-stats.org>"
 	website		: "https://jasp-stats.org"
 	license		: "GPL (>= 2)"
+	icon        : "exampleIcon.png" // Located in /inst/icons/
+	preloadData: true
+	requiresData: true
+
+
+	GroupTitle
+	{
+		title:	qsTr("Basic functions")
+	}
+
+	Analysis
+	{
+	  title: qsTr("Add one")      // Title for window
+	  menu: qsTr("Add one")       // Title for ribbon
+	  func: "addOne"        // Function to be called
+      qml: "Integer.qml"    // Design input window
+	}
+
+	Analysis
+	{
+	  title: qsTr("Load data")
+	  menu: qsTr("Load data")
+	  func: "processData"
+	  qml: "Data.qml"
+	}
+
+	Analysis
+	{
+	  title: qsTr("Tabular results")
+	  menu: qsTr("Tabular results")
+	  func: "processTable"
+	  qml: "Table.qml"
+	}
+
+	GroupTitle
+	{
+		title:	qsTr("Plotting")
+	}
+
+	Analysis
+	{
+	  title: qsTr("Plot a parabola")
+	  func: "parabola"
+	  qml: "Parabola.qml"
+	}
 }

inst/qml/Data.qml

@@ -0,0 +1,53 @@
+//
+// 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
+// <http://www.gnu.org/licenses/>.
+//
+import QtQuick			2.8
+import QtQuick.Layouts	1.3
+import JASP.Controls	1.0
+import JASP.Widgets		1.0
+import JASP				1.0
+
+Form
+{
+
+  Text
+  {
+      text: qsTr("This example shows how to load a dataset and perform a simple operation on it")
+  }
+
+  VariablesForm
+  {
+    AvailableVariablesList { name: "allVariables" }
+
+    AssignedVariablesList  {
+      name: "ts"
+      label: qsTr("Times (t)")
+      info: qsTr("This info entry adds documentation to the (i) icon in the analysis file. E.g., Specify variable containing the time.")
+      singleVariable: true
+      allowedColumns: ["scale"]
+    }
+
+    AssignedVariablesList  {
+      name: "xs"
+      label: qsTr("Positions (x)")
+      info: qsTr("This info entry adds documentation to the (i) icon in the analysis file. E.g., Specify variable containing the positions.")
+      singleVariable: true
+      allowedColumns: ["scale"]
+    }
+  }
+
+}

inst/qml/Integer.qml

@@ -0,0 +1,44 @@
+//
+// 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
+// <http://www.gnu.org/licenses/>.
+//
+import QtQuick			2.8
+import QtQuick.Layouts	1.3
+import JASP.Controls	1.0
+import JASP.Widgets		1.0
+import JASP				1.0
+
+Form
+{
+
+  Text
+  {
+      text: qsTr("This example shows how to manually introduce an input and perform a simple operation on it")
+  }
+
+	IntegerField
+	{
+		name: "my_number"              // This will map to options$my_number in R
+		label: qsTr("Type a number")   // qsTr allows for future translations
+
+		// We can add some extra control parameters
+		min: 1
+		defaultValue: 10
+		fieldWidth: 50
+		max: 1000
+	}
+
+}