create_study: Create Study

Description Usage Arguments Value

View source: R/sampledb.R

Description

Create a new study entry in the database. Throws a ValueError if the short_code is not unique

Usage

1
2
3
4
5
6
7
create_study(
  title,
  short_code,
  is_longitudinal,
  lead_person,
  description = NULL
)

Arguments

title

the title of the study

short_code

a short unique string that is used to refer to the study

is_longitudinal

logical indicating if the study is a longitudinal study. Setting this value will result in extra logical checks when adding samples to ensure they have collection dates associated

lead_person

the person responsible for the study samples

description

an optional field to give more context to the study

Value

returns the study object created


m-murphy/sampledblib.r documentation built on Jan. 24, 2022, 5:11 a.m.