Template for a Basic jamovi Module

• official documentation
• a beginners guide to jamovi

TL;DR

• Use this repo as template: https://github.com/sbalci/jamoviTemplate to generate a new repo

• Use R >= 4.0.2

• Current package repository is: https://cran.microsoft.com/snapshot/2020-08-24

• Install jamovi

  • Get the latest (1.6.3) https://www.jamovi.org/download.html
  • If using mac use this: https://www.jamovi.org/downloads/jamovi-unsigned.zip

• Install jmvtools package with:

install.packages('jmvtools', repos=c('https://repo.jamovi.org', 'https://cran.r-project.org'))

- Install jamovi package family:

options(repos = c('https://cran.microsoft.com/snapshot/2020-08-24'))

suppressPackageStartupMessages({
  if (!requireNamespace('jmvtools'))
  {
    install.packages('jmvtools',
                     repos = c('https://repo.jamovi.org', 'https://cran.r-project.org'))
  }
})
suppressPackageStartupMessages(library('jmvtools'))

suppressPackageStartupMessages({
  if (!requireNamespace('jmv')) {
    install.packages('jmv', dependencies = TRUE)
  }
})
suppressPackageStartupMessages(library('jmv'))

suppressPackageStartupMessages({
  if (!requireNamespace('jmvconnect')) {
    install.packages('jmvconnect', dependencies = TRUE)
  }
})
suppressPackageStartupMessages(library('jmvconnect'))

suppressPackageStartupMessages({
  if (!requireNamespace('jmvcore')) {
    install.packages('jmvcore', dependencies = TRUE)
  }
})
suppressPackageStartupMessages(library('jmvcore'))

suppressPackageStartupMessages({
  if (!require('devtools')) {
    install.packages('devtools')
  }
})
suppressPackageStartupMessages(library('devtools'))

• Locate jamovi bin folder:

  • windows: jmvtools::check("C://Program Files//jamovi//bin")
    I recommend changing folder name from default jamovi x.x to jamovi
  • mac: jmvtools::check("~/Applications/jamovi.app")

• Inside this repo folder in R run jmvtools::install()

• A file named jamoviTemplate.jmo and install this module to jamovi

• The repo is like an R package except jamovi folder.

• You need to edit R/...b.R files.

  • https://dev.jamovi.org/tuts0104-implementing-an-analysis.html
  • https://dev.jamovi.org/tuts0105-debugging-an-analysis.html

• run jmvtools::install() again.

• Let me know how it goes :)

linux needs additional installations

- linux codes

https://cran.r-project.org/bin/linux/ubuntu/README.html

• flatpak

flatpak install -y flathub org.freedesktop.Platform//19.08
flatpak install -y flathub org.freedesktop.Sdk//19.08

sudo apt install flatpak
sudo apt install gnome-software-plugin-flatpak
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install flathub org.jamovi.jamovi
flatpak run org.jamovi.jamovi
flatpak remote-add --if-not-exists flathub https://flathub.org/repo/flathub.flatpakrepo
flatpak install flathub org.freedesktop.Sdk//19.08
flatpak install flathub org.freedesktop.Platform//19.08

sudo apt install flatpak-builder
flatpak-builder --run build_folder org.app.json

• R

sudo add-apt-repository 'deb https://cloud.r-project.org/bin/linux/ubuntu focal-cran40/'
sudo apt install r-base r-base-core r-recommended r-base-dev

• RStudio

sudo apt install '/home/serdarbalci/Downloads/rstudio-1.3.1073-amd64.deb'

• git

sudo apt install git-all

• gtk3

sudo apt install libcanberra-gtk-module libcanberra-gtk3-module

• V8 (I could not make this run)

sudo apt-get install libv8-dev
sudo apt-get install libnode-dev


sudo apt install build-essential
gcc --version
sudo apt-get install gfortran

sudo apt-get install r-base-dev
git status


sudo apt install libcurl4-openssl-dev
sudo apt install libxml2-dev

add analysis

jmvtools::addAnalysis(name = 'neofun', title = 'New Function')

using devtools

• If you want to use devtools, remove NAMESPACE file.

how jamovi module functions?

• See: jamovi working structure

need inspiration?

• all code is available:
  https://github.com/jonathon-love/jamovi-library/blob/master/modules.yaml

• use advanced search in github

• check out my codes:
  https://github.com/sbalci/ClinicoPathJamoviModule

how to remove functions?

• delete these files:

.
└── jamoviTemplate/
    ├── R/
    │   ├── neofun.b.R
    │   └── neofun.h.R
    └── jamovi/
        ├── neofun.a.yaml
        ├── neofun.r.yaml
        └── neofun.u.yaml 

• also delete this portion from analysis portion of jamovi/0000.yaml

  - title: New Function
    name: neofun
    ns: jamoviTemplate
    menuGroup: jamoviTemplate
    menuTitle: New Function