set_source.db: Create db-based Source

View source: R/source.R

set_source.dbR Documentation

Create db-based Source

Description

This is a method for cohortBuilder [set_source()] generic. It creates Source object which is based on connection to database tables.

Usage

## S3 method for class 'db'
set_source(
  dtconn,
  primary_keys = NULL,
  binding_keys = NULL,
  source_code = NULL,
  description = NULL,
  ...
)

Arguments

dtconn

Object of class "db" defining connection to the database, schema and tables names. Should be created with dbtables.

primary_keys

Definition of data 'primary_keys'. See primary_keys.

binding_keys

Binding keys definition see binding-keys.

source_code

An expression presenting low-level code for creating source. When provided, used as a part of reproducible code output.

description

A named list storing the source objects description. Can be accessed with description Cohort method.

...

Source type specific parameters. Available in 'attributes' list of resulting object.


r-world-devs/cohortBuilder.db documentation built on May 23, 2022, 12:08 a.m.