Browse Source

Regenerated documentation

master
Maxime Wack 6 years ago
parent
commit
a575815f61
5 changed files with 23 additions and 14 deletions
  1. +2
    -2
      man/add_encounters.Rd
  2. +2
    -2
      man/add_observations.Rd
  3. +0
    -3
      man/add_patients_demodata.Rd
  4. +3
    -3
      man/delete_users.Rd
  5. +16
    -4
      man/populate_ont.Rd

+ 2
- 2
man/add_encounters.Rd View File

@@ -4,8 +4,8 @@
\alias{add_encounters}
\title{Add encounters to the CRC cell}
\usage{
add_encounters(encounters, project, patient_mapping, host = "", admin = "",
pass = "")
add_encounters(encounters, project, patient_mapping = "", host = "",
admin = "", pass = "")
}
\arguments{
\item{encounters}{A dataframe of patients}


+ 2
- 2
man/add_observations.Rd View File

@@ -4,8 +4,8 @@
\alias{add_observations}
\title{Add observations to the CRC cell}
\usage{
add_observations(observations, patient_mapping, encounter_mapping, host = "",
admin = "", pass = "")
add_observations(observations, patient_mapping = "", encounter_mapping = "",
host = "", admin = "", pass = "")
}
\arguments{
\item{observations}{A dataframe of observation facts}


+ 0
- 3
man/add_patients_demodata.Rd View File

@@ -17,9 +17,6 @@ add_patients_demodata(patients, project, host = "", admin = "", pass = "")

\item{pass}{The password for the admin account}
}
\value{
A patient mapping dataframe for the patients
}
\description{
Add patients to the CRC cell, generate new encrypted IDs,
}


+ 3
- 3
man/delete_users.Rd View File

@@ -4,16 +4,16 @@
\alias{delete_users}
\title{Delete users}
\usage{
delete_users(host = "127.0.0.1", admin, pass, users)
delete_users(users, host = "", admin = "", pass = "")
}
\arguments{
\item{users}{A character vector of user ids}

\item{host}{The host to connect to}

\item{admin}{The admin account for the PostgreSQL database}

\item{pass}{The password for the database admin}

\item{users}{A character vector of user ids}
}
\description{
Delete i2b2 users from the instance


+ 16
- 4
man/populate_ont.Rd View File

@@ -4,8 +4,10 @@
\alias{populate_ont}
\title{Populate an empty ontology table}
\usage{
populate_ont(ont, modi = NULL, name, scheme, include_code = T, host = "",
admin = "", pass = "")
populate_ont(ont, modi = NULL, name, scheme, include_code = T,
def_facttablecolumn = "concept_cd", def_tablename = "concept_dimension",
def_columnname = "concept_path", def_columndatatype = "T",
def_operator = "LIKE", host = "", admin = "", pass = "")
}
\arguments{
\item{ont}{The ontology to insert}
@@ -18,6 +20,16 @@ populate_ont(ont, modi = NULL, name, scheme, include_code = T, host = "",

\item{include_code}{Whether to include the code in the label or not}

\item{def_facttablecolumn}{Default value for that column}

\item{def_tablename}{Default value for that column}

\item{def_columnname}{Default value for that column}

\item{def_columndatatype}{Default value for that column}

\item{def_operator}{Default value for that column}

\item{host}{The host to connect to}

\item{admin}{The admin account for the PostgreSQL database}
@@ -29,12 +41,12 @@ Populate an empty ontology table
}
\details{
Populate an ontology table
ont is a character vector containing all the leaves of the ontology
ont is a dataframe containing at least the c_fullname column, a character vector containing all the leaves of the ontology
with their respective path, in the form
code_level1 label_level1\\code_level2 label_level2\\...\\code_leaf label_leaf
The function rebuilds the folders automatically

modi is a character vector containing the modifiers, in the form
modi is a dataframe containing at least the c_fullname column, a character vector containing the modifiers, in the form
code_modi label_modi
The modifiers apply on all the ontology
}

Loading…
Cancel
Save