Update_Group_Properties: Batch update group properties

View source: R/tools.R

Update_Group_PropertiesR Documentation

Batch update group properties

Description

This allows you to change the group properties of as many groups as you like.

Usage

Update_Group_Properties(Group_Update_Table)

Arguments

Group_Update_Table

This is a data.table that has the column "gid" and one or more of the following columns: "new_grelevance", "new_group_name", "new_group_order", "new_description", "new_language", "new_randomization_group". These columns contain the information that you want to use to update the respective group parameters.

  • gid: the gid of the group you would like to update <this column is mandatory!>

  • new_grelevance: <optional> the group relevance you want to update- simply a string with a relevance equation

  • new_group_name: <optional> change the group name

  • new_group_order: <optional> change the order in which the groups are presented (this has restrictions)

  • new_description: <optional> change group description

  • new_language: <optional> change language of group

  • new_randomization_group: <optional> assign the group to a randomization group- simply a string with the randomization group's name

Examples

## Not run: 
Update_Group_Properties(data.table(gid = 123455, new_grelevance = 1))

## End(Not run)


bpresentati/surveyR documentation built on March 19, 2022, 3:40 a.m.