update_Citavi_ctv6: Write into Citavi database (via SQL update query)

View source: R/update_Citavi_ctv6.R

update_Citavi_ctv6R Documentation

Write into Citavi database (via SQL update query)

Description

Write into Citavi database (via SQL update query)

Usage

update_Citavi_ctv6(
  CitDat = NULL,
  path = NULL,
  CitDBTableName = NULL,
  CitDatVarToCitDBTableVar = NULL,
  quiet = TRUE
)

Arguments

CitDat

A table (likely originally read via read_Citavi_ctv6).

path

Path to the local Citavi project file (.ctv6, i.e. CitDB).

CitDBTableName

Name of the table from the connected Citavi database to be updated.

CitDatVarToCitDBTableVar

Names of Citavi fields to be updated for all references in the Citavi project. Such a name must be both: (i) a column name in CitDat and (ii) a respective field name in the CitDB. SQL queries will be created to update all CitDatVarToCitDBTableVar for all references/StaticIDs.

quiet

If TRUE (default), all output will be suppressed.

Details

[Experimental]
The underlying core functions are DBI::dbConnect() RSQLite::SQLite() and DBI::dbSendQuery().

Examples

library(dplyr, warn.conflicts = FALSE)

# use this package's example Citavi project
example_path <- example_file("3dupsin5refs/3dupsin5refs.ctv6")
CitDat <- read_Citavi_ctv6(example_path)

# looks like this
CitDat %>% select(StaticIDs, Title, Year)

# let's set all years to 1990
CitDat %>%
  mutate(AlteredYear = "1990") %>%
  update_Citavi_ctv6(
    path = example_path,
    CitDBTableName = "Reference",
    CitDatVarToCitDBTableVar = c("AlteredYear" = "Year"),
    quiet = FALSE
  )

# it worked!
read_Citavi_ctv6(example_path) %>% select(StaticIDs, Title, Year)

# we should change it back
CitDat %>%
  mutate(OriginalYear = c("2018", "2019", "2019", "2019", "2019")) %>%
  update_Citavi_ctv6(
    path = example_path,
    CitDBTableName = "Reference",
    CitDatVarToCitDBTableVar = c("OriginalYear" = "Year"),
    quiet = FALSE
  )

# it worked!
read_Citavi_ctv6(example_path) %>% select(StaticIDs, Title, Year)


SchmidtPaul/CitaviR documentation built on Jan. 31, 2023, 5 a.m.