Table Selection Functions

This page contains the main QScript code for selecting rows and columns from tables, which is used by Tables - Select, Calculate - First, and Calculate - Last.

To make these functions available when writing a QScript or Rule see JavaScript Reference.

selectFromTables(default_selection_mode)

This is the main function used by the QScript Tables - Select. It works with tables the user has selected on their page and adds them as Inputs to Tables - Select Rows and Columns from Table. The one input default_selection_mode specifies which selection mode should be chosen as the default for the Inputs Select rows by and Select columns by for each table. See the documentation in Tables - Select for a full list of possible values, the default is "Selecting options below".

Source Code

includeWeb("QScript R Output Functions"); // used for generateUniqueRObjectName
includeWeb("QScript Table Functions");     // for recursiveGetAllTablesInGroup

function selectFromTables(default_selection_mode = "Selecting options below") {
    if (Q.fileFormatVersion() < 20.00) {
        let msg = 'Sorry, you must upgrade to a Q version >= 5.12 to use this feature.' +
                  'If you are unable to upgrade, you may instead use: ' +
                  '    \'Create > Tables > Select Rows and Columns from Table\'.' +
            'This will similiary insert a new output that you may use to select a subset' +
	' of rows and columns to display for any of the tables in your project.';
        log(msg);
        return false;
    }
    const VALID_ROUTPUT_CLASSES = ["matrix","array","data.frame",
				   "table", "numeric", "character",
				   "integer", "factor", "logical"];
    let selections = project.report.selectedRaw();
    let is_displayr = (!!Q.isOnTheWeb && Q.isOnTheWeb());
    let valid_selections;
    if (project.report.selectedRaw().length === 0 || (selections.length === 1 && selections[0].type === "ReportGroup")) {
	var group = project.currentPage === undefined ? false : project.currentPage();
	if (!group) {
	    if (!is_displayr)
		group = project.report;
	    else {
		group = project.report.appendGroup();
		group.name = "New page";
	    }
	}
        valid_selections = [];
    }else {
        valid_selections = selections.filter(s => (s.type === "Table" && s.question !== null)
              || (s.type === "R Output" && s.error === null
                  && s.outputClasses.filter(c => VALID_ROUTPUT_CLASSES.includes(c)).length > 0));
        if (valid_selections.length === 0) {
            let msg = "The current selections cannot be used with this feature. " +
		"Please click on the Table(s) and/or R Output(s) containing " +
		"tables to be selected from and rerun.";
	    log(msg);
            return false;
        }
        if (valid_selections.length < selections.length)
            log("Some selections were not a Q Table or an R Output (containing a table) and they will be ignored.");
        var group = valid_selections[0].group;
    }
    let output_name = generateUniqueRObjectName('selected.table');
    let prefilled_controls;
    if (valid_selections.length > 1){
        let table_names = prompt("Please enter names for the " + valid_selections.length + " selected tables, separated by commas.");
        let cb = group.appendControl("Combobox");
        cb.top = 0;
        cb.left = 0;
        cb.placeholderText = "Select table to show...";
        cb.selectionMode = "SingleSelection";
        cb.whenItemListChanges = 'KeepCurrentSelection';
        cb.itemList = table_names.split(",");
        cb.selectedItems = table_names.split(",").slice(0,1);	
        prefilled_controls = {
            "formTableNames": table_names,
            "formTableSelection": cb.guid
        }
    }else
        prefilled_controls = {};
    for(let i = 0; i < valid_selections.length; i++) {
       valid_selections.hiddenFromExportedViews = true;
       prefilled_controls["formTable"+(i+1)] = valid_selections[i].guid;
       prefilled_controls["formRowSelectorTbl"+(i+1)] = default_selection_mode;
       prefilled_controls["formColSelectorTbl"+(i+1)] = default_selection_mode.replace("row", "column");
    }
    let selected_table = group.appendStandardR("Tables - Select Rows and Columns from Table", prefilled_controls);
    project.report.setSelectedRaw([selected_table]);
    return true;
}

function insertDataTable(raw_table = true) {
    if (Q.fileFormatVersion() < 20.00) {
        let msg = 'Sorry, you must upgrade to a Q version >= 5.12.0 to use this feature.' +
                  'If you are unable to upgrade, you may instead use: ' +
                  '\'Create > Tables > Raw Data - Variables\'.';
        log(msg);
        return false;
    }
    let displayr = !!Q.isOneTheWeb && Q.isOnTheWeb();
    let selected_variables = project.report.selectedVariables();
    let page = project.currentPage === undefined ? false : project.currentPage();
    if (!page) {
        if (!displayr)
            page = project.report;
        else {
            page = project.report.appendGroup();
            page.name = "New page";
        }
    }

    let prefilled_controls = {};
    if (selected_variables.length > 0) {
        if (!raw_table) { // warn users that text variables are ignored if found
            let has_text_vars = selected_variables.some(v => v.question.questionType.includes("Text"));
            if (has_text_vars)
                log("Selected text variables have not been included in the output as the descriptive statistics are not meaningful. Consider changing their type if appropriate.");
        }
        prefilled_controls["formVariables"] = selected_variables.map(v => v.guid).join(";");
    }

    let page_name = raw_table ? "Tables - Raw Data - Variables" : "Tables - Descriptive Statistics";
    let table = page.appendStandardR(page_name, prefilled_controls);

    if (Q.fileFormatVersion() > 8.65)
        project.report.setSelectedRaw([table]);
    return true;
}