run_initial_setup: Create a jsPsychHelpeR project for your data

In gorkang/jsPsychHelpeR: Standardize and automatize data preparation and analysis of jsPsych experiments created with jsPsychMaker

Create a jsPsychHelpeR project for your data

Description

run_initial_setup() will read your data and create a jsPsychHelpeR project tailoring the _targets.R file to the tasks included in the data.

Usage

run_initial_setup(
  pid,
  download_files = FALSE,
  data_location = NULL,
  download_task_script = FALSE,
  folder = "~/Downloads/jsPsychHelpeRtest",
  sensitive_tasks = c(""),
  credentials_file = ".vault/.credentials",
  dont_ask = FALSE,
  open_rstudio = TRUE
)

Arguments

pid	project id
download_files	Download the data files? FALSE / TRUE If TRUE, requires sFTP server credentials to be located in credentials_file, by default: .vault/credentials See .vault/credentials_TEMPLATE for more details
data_location	Local folder where the raw data for the project is located
download_task_script	should download the task scripts? (requires server credentials) FALSE / TRUE
folder	location for the project
sensitive_tasks	short names of the sensitive tasks in the protocol, if any
credentials_file	Path to .credentials file. By default: .vault/.credentials
dont_ask	answer YES to all questions so the process runs uninterrupted. This will:
open_rstudio	Open RStudio with the new project TRUE / FALSE

Value

Opens a new RStudio project

Examples

run_initial_setup(pid = 999, download_files = FALSE,
                  data_location = system.file("extdata", package = "jsPsychHelpeR"),
                  download_task_script = FALSE, 
                  folder = tempdir(),
                  sensitive_tasks = c(""), 
                  credentials_file = ".vault/.credentials",
                  dont_ask = TRUE, 
                  open_rstudio = FALSE)

gorkang/jsPsychHelpeR documentation built on Oct. 15, 2024, 8 a.m.