schmidtpaul/citavir

A set of tools for dealing with Citavi data in R

CitaviR

This is an unofficial helper package for dealing with Citavi.
I am not affiliated with Citavi, just a fan.

Citavi (Official Website, Official GitHub) is a software program for reference management and knowledge organization. When working with local Citavi projects (as opposed to cloud or server projects) you can directly work on the (database stored in) the .ctv6 file via SQL. CitaviR provides functionality for

1. reading the data from the .ctv6 file
2. dealing with the data while it is outside Citavi to get the most out of it
3. writing/updating the data into the .ctv6 file

Installation

You can install the development version of CitaviR from GitHub:

devtools::install_github('SchmidtPaul/CitaviR')

Example

You can find an example workflow on the Get Started page.

citavir's Issues

detect_country()

Making use of countrycode::codelist, detect the country from keyword, title and/or abstract like so:

read_Citavi_xlsx(example_xlsx('3dupsin5refs.xlsx')) %>%
   detect_country()

• write function
• write tests
• provide macro to import results into Citavi

Can it add item to the .ctv6?

I want to add new record to the .ctv6, but I didn't find the function?

find_obvious_dups()

Find obvious duplicates based on title and year and add gained information as columns like so:

read_Citavi_xlsx(example_xlsx('3dupsin5refs.xlsx')) %>%
   find_obvious_dups()

• write function
• write tests
• write in example of README.Rmd
• provide macro to import results into Citavi

Handle obvious duplicates example in vignette does not work

It does not actually alter the dataset?
https://schmidtpaul.github.io/CitaviR/articles/CitaviR.html#handle-obvious-duplicates

read_Citavi_xlsx()

Import like so:

import_path <- example_xlsx('3dupsin5refs.xlsx')
CitDat <- read_Citavi_xlsx(import_path ) 

• write function
• write tests
• write in example of README.Rmd
• use col_types = for all columns based on the Column Info Master of #5
• do we need str_replace_all(Categories, "\\s+", " ") for all text columns?
• prevent warnings Coercing text to numeric for setSuggestedColTypes = FALSE

write_Citavi_xlsx()

Export processed CitDat to Excel with modified path like so:

import_path <- example_xlsx('3dupsin5refs.xlsx')

CitDat <- read_Citavi_xlsx(import_path ) %>%
   find_obvious_dups() %>%
   handle_obvious_dups()

write_Citavi_xlsx(CitDat, import_path)

• write function
• write tests
• write in example of README.Rmd

handle_obvious_dups()

Take obvious duplicates, mark one as the "non-duplicate" and all others as the "duplicates" while making sure to extract all information across all duplicates and save it in the fields of the "non-duplicate"

read_Citavi_xlsx(example_xlsx('3dupsin5refs.xlsx')) %>%
   find_obious_dups() %>%
   handle_obvious_dups()

• write function
• write tests
• write in example of README.Rmd
• provide macro to import results into Citavi
• document smart handling of Online-Address
• provide a "default" or "all" list of fields for fieldsToHandle=

example datasets

Add more example datasets with these features:

• is large enough that find_potential_dups() has to go trough if (NumberOfComp > maxNumberOfComp).
• has different languages for detect_language()
• has different country names in abstract, title, keyword for detect_country()
• has nice entries for showing the smart handling of Online Address via handle_obvious_dups()

Column Info Master

For all columns Citavi can export, have a master file in CitaviR that lists

• English names
• names in all other languages
• type (text or integer)
• variable name for macro syntax

detect_language()

Make use of textcat to identify the language of the abstract like so:

read_Citavi_xlsx(example_xlsx('3dupsin5refs.xlsx')) %>%
   detect_language()

• write function
• write tests
• provide macro to import results into Citavi

find_potential_dups()

Find potential duplicates based on title and year and add gained information as columns like so:

read_Citavi_xlsx(example_xlsx('3dupsin5refs.xlsx')) %>%
   find_obvious_dups() %>%
   find_potential_dups()

• write function
• write tests
• write a vigniette
• provide macro to import results into Citavi
• add quiet = TRUE