Calculate details of a primary endpoint of a study
Source:R/f_primaryEndpointDescription.R
f.primaryEndpointDescription.Rd
Trial concept calculated: full description of the primary endpoint, concatenating with " == " its title, description, time frame of assessment. The details vary by register. The text description can be used for identifying trials of interest or for analysing trends in primary endpoints, which among the set of all endpoints are most often used for determining the number of participants sought for the study.
Arguments
- df
data frame such as from dbGetFieldsIntoDf. If `NULL`, prints fields needed in `df` for calculating this trial concept, which can be used with dbGetFieldsIntoDf.
Value
data frame with columns `_id` and `.primaryEndpointDescription`, which is a list (that is, one or more items in one vector per row; the background is that some trials have several endpoints as primary).
Examples
# fields needed
f.primaryEndpointDescription()
#> $euctr
#> [1] "e51_primary_end_points"
#> [2] "e511_timepoints_of_evaluation_of_this_end_point"
#>
#> $ctgov
#> [1] "primary_outcome.measure" "primary_outcome.description"
#> [3] "primary_outcome.time_frame"
#>
#> $ctgov2
#> [1] "protocolSection.outcomesModule.primaryOutcomes.measure"
#> [2] "protocolSection.outcomesModule.primaryOutcomes.description"
#> [3] "protocolSection.outcomesModule.primaryOutcomes.timeFrame"
#>
#> $isrctn
#> [1] "trialDescription.primaryOutcome"
#>
#> $ctis
#> [1] "authorizedApplication.authorizedPartI.trialDetails.trialInformation.endPoint.primaryEndPoints.endPoint"
#> [2] "authorizedPartI.trialDetails.trialInformation.endPoint.primaryEndPoints.endPoint"
#>
if (FALSE) { # \dontrun{
# apply trial concept when creating data frame
dbc <- nodbi::src_sqlite(
dbname = system.file("extdata", "demo.sqlite", package = "ctrdata"),
collection = "my_trials", flags = RSQLite::SQLITE_RO
)
trialsDf <- dbGetFieldsIntoDf(
calculate = "f.primaryEndpointDescription",
con = dbc
)
} # }