labkey.updateRows {Rlabkey} | R Documentation |
Send data from an R session to update existing rows of data in the database.
labkey.updateRows(baseUrl, folderPath, schemaName, queryName, toUpdate)
baseUrl |
a string specifying the baseUrl for the labkey server |
folderPath |
a string specifying the folderPath |
schemaName |
a string specifying the schemaName for the query |
queryName |
a string specifying the queryName |
toUpdate |
a data frame containing the row(s) of data to be updated |
A single row or multiple rows of data can be updated. The toUpdate
data frame should contain
the rows of data to be updated and must be created with the stringsAsFactors
option
set to FALSE. The names of the data in the data frame must be the column names from the
labkey database.
NOTE: Each variable in a dataset has both a column label and a column name. The column label is visible at the top of each column on the web page and is longer and more descriptive. The column name is shorter and is used “behind the scenes” for database manipulation. It is the column name that must be used in the Rlabkey functions when a column name is expected. To identify a particular column name in a dataset on a web site, use the “export to R script” option available as a drop down option under the “views” tab for each dataset.
In versions 0.0.5 and earlier, labkey.updateRows
had a stripAllHidden
argument. This argument did not perform a useful function and has since been removed.
A list is returned with named categories of command, rowsAffected, rows, queryName, containerPath and schemaName. The schemaName, queryName and containerPath properties contain the same schema, query and folder path used in the request. The rowsAffected property indicates he number of rows affected by the API action. This will typically be the same number as passed in the request. The rows property contains a list of row objects corresponding to the rows updated.
Valerie Obenchain
http://www.omegahat.org/RCurl/,
http://dssm.unipa.it/CRAN/web/packages/rjson/rjson.pdf,
https://www.labkey.org/project/home/begin.view
labkey.selectRows
, labkey.executeSql
, makeFilter
,
labkey.insertRows
,
labkey.deleteRows
## Insert, update and delete # Note that users must have the necessary permissions in the database # to be able to modify data through the use of these functions ### Not run #newrow <- data.frame(name="Frank", age=11, stringsAsFactors=FALSE) #labkey.insertRows( #baseUrl="https://atlas-test.scharp.org/cpas", #folderPath="/CHAVI/Analysis/vobencha", #schemaName="lists", #queryName="testlist", #toInsert=newrow) # #updaterow=data.frame(Key=4,name="Patty",age=11, stringsAsFactors=FALSE) #mydata <- labkey.updateRows( #baseUrl="https://atlas-test.scharp.org/cpas", #folderPath="/CHAVI/Analysis/vobencha", #schemaName="lists", #queryName="testlist", #toUpdate=updaterow) # #deleterow <- data.frame(Key=1, stringsAsFactors=FALSE) #mydata <- labkey.deleteRows( #baseUrl="https://atlas-test.scharp.org/cpas", #folderPath="/CHAVI/Analysis/vobencha", #schemaName="lists", #queryName="testlist", #toDelete=deleterow)