Dataset : add_column
Dataset_AddColumn.RdAdd column(s) to the table. Note that this does not store the column(s) in
Synapse. You must call the synStore() function on this Dataset instance to
store the column(s) in Synapse. This is a convenience function to eliminate
the need to manually add the column(s) to the $columns list.
This function will add an item to the $columns attribute of the Dataset
instance. $columns is a named list where the key is the name of the column
and the value is the Column object.
Examples
if (FALSE) { # \dontrun{
## Example 1: Adding a single column
# This example shows how you may add a single column to a dataset and then
# store the change back in Synapse.
library(synapser)
synLogin()
dataset = Dataset(id = "syn1234") |> synGet(table_options = TableOptions(include_columns = TRUE))
dataset |> synAddColumn(
Column(name = "my_column", column_type = "STRING")
)
dataset |> synStore()
## Example 2: Adding multiple columns
# This example shows how you may add multiple columns to a dataset and then
# store the change back in Synapse.
library(synapser)
synLogin()
dataset = Dataset(id = "syn1234") |> synGet(table_options = TableOptions(include_columns = TRUE))
dataset |> synAddColumn(list(
Column(name = "my_column", column_type = "STRING"),
Column(name = "my_column2", column_type = "INTEGER")
))
dataset |> synStore()
## Example 3: Adding a column at a specific index
# This example shows how you may add a column at a specific index to a
# dataset and then store the change back in Synapse. If the index is out of
# bounds the column will be added to the end of the list.
library(synapser)
synLogin()
dataset = Dataset(id = "syn1234") |> synGet(table_options = TableOptions(include_columns = TRUE))
dataset |> synAddColumn(
Column(name = "my_column", column_type = "STRING"),
# Add the column at the beginning of the list
index = 0L
)
dataset |> synStore()
} # }