CastorData-class: Class used to access Castor REST API.
In castoredc/castoRedc: Wraps Castor API for easy data access
CastorData-class R Documentation
Class used to access Castor REST API.
Description
Class used to access Castor REST API.
Class used to access Castor REST API.
Format
An R6 class object.
Methods
-
getStudies(): Retries all Castor studies in account.
-
getFields(study_id, include, page): Gets all fields for a given
study.
-
getParticipants(study_id): Gets all participants for a given
study.
-
getStudyDataPoints(study_id, participant_id,
filter_types): Gets all data points
for a given study and participant. Filter types may be supplied for fields types
as a character vector of field types.
-
getStudyData(study_id,
load_study_data,
repeating_data_instances,
survey_instances,
translate_option_values,
filter_types):
creates a named nested list with a dataframe for all study data, a
list of dataframes for repeating data instances and a list of dataframes
for survey instances. Can toggle which data is extracted, and whether
option group values are translated to labels.
-
getOptionGroups(study_id): creates a data
frame with all option groups for a given study with each row representing an
option group.
-
getRepeatingDataInstancesByParticipant(study_id, participant_id): creates a data
frame with all repeating data for a given participant with each row
representing a field.
-
adjustTypes = function(field_to_type, values,
type_to_func): Utility method
for casting columns to their intended type. Users can supply their own list
of data type : function (for casting the data) mappings on instantiation of
this class, CastorAPIWrapper.
-
transformOptionGroups = function(dataframe, study_id): Utility method
for transforming a dataframe with option group values to the correct labels.
Super class
castoRedc::CastorAPIWrapper -> CastorData
Methods
Public methods
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
Inherited methods
castoRedc::CastorAPIWrapper$castorOAuth()castoRedc::CastorAPIWrapper$collectPages()castoRedc::CastorAPIWrapper$getField()castoRedc::CastorAPIWrapper$getFieldsPages()castoRedc::CastorAPIWrapper$getForm()castoRedc::CastorAPIWrapper$getFormsPages()castoRedc::CastorAPIWrapper$getParticipant()castoRedc::CastorAPIWrapper$getParticipantsPages()castoRedc::CastorAPIWrapper$getRepeatingData()castoRedc::CastorAPIWrapper$getRepeatingDataForm()castoRedc::CastorAPIWrapper$getRepeatingDataFormsPages()castoRedc::CastorAPIWrapper$getRepeatingDataInstanceMetadataPages()castoRedc::CastorAPIWrapper$getRepeatingDatasPages()castoRedc::CastorAPIWrapper$getRequest()castoRedc::CastorAPIWrapper$getStudiesPages()castoRedc::CastorAPIWrapper$getStudy()castoRedc::CastorAPIWrapper$getStudyDataPoint()castoRedc::CastorAPIWrapper$getStudyDataPointsPages()castoRedc::CastorAPIWrapper$getSurvey()castoRedc::CastorAPIWrapper$getSurveyPackage()castoRedc::CastorAPIWrapper$getSurveyPackageInstance()castoRedc::CastorAPIWrapper$getSurveyPackageInstancesPages()castoRedc::CastorAPIWrapper$getSurveyPackagesPages()castoRedc::CastorAPIWrapper$getSurveysPages()castoRedc::CastorAPIWrapper$getUsersPages()castoRedc::CastorAPIWrapper$getVisit()castoRedc::CastorAPIWrapper$getVisitsPages()castoRedc::CastorAPIWrapper$initialize()
Method getStudies()
Usage
CastorData$getStudies()
Method getUsers()
Usage
CastorData$getUsers()
Method getForms()
Usage
CastorData$getForms(study_id)
Method getFields()
Usage
CastorData$getFields(study_id, include = "optiongroup")
Method getVisits()
Usage
CastorData$getVisits(study_id)
Method getSurveys()
Usage
CastorData$getSurveys(study_id, include = "forms", page = NULL)
Method getSurveyPackages()
Usage
CastorData$getSurveyPackages(study_id)
Method getSurveyPackageInstances()
Usage
CastorData$getSurveyPackageInstances(study_id)
Method getRepeatingDatas()
Usage
CastorData$getRepeatingDatas(study_id)
Method getRepeatingDataForms()
Usage
CastorData$getRepeatingDataForms(study_id)
Method getParticipants()
Usage
CastorData$getParticipants(study_id, filter_archived = TRUE)
Method getStudyDataPointsBulkByParticipant()
Usage
CastorData$getStudyDataPointsBulkByParticipant(study_id, participant_id)
Method getStudyDataPointsBulk()
Usage
CastorData$getStudyDataPointsBulk(study_id_ = FALSE)
Method getOptionGroups()
Usage
CastorData$getOptionGroups(study_id = FALSE)
Method getRepeatingDataInstancesByParticipant()
Usage
CastorData$getRepeatingDataInstancesByParticipant(study_id, participant_id)
Method getRepeatingDataInstances()
Usage
CastorData$getRepeatingDataInstances(
study_id,
participant_id = NULL,
id_to_field_name = NULL
)
Method getRepeatingDataInstancesBulk()
Usage
CastorData$getRepeatingDataInstancesBulk(
study_id_,
participant_id_ = NULL,
id_to_field_name_ = NULL,
page_size = NULL
)
Method getRepeatingDataInstanceMetadata()
Usage
CastorData$getRepeatingDataInstanceMetadata(study_id)
Method getSurveyInstances()
Usage
CastorData$getSurveyInstances(
study_id,
participant_id = NULL,
id_to_field_name = NULL
)
Method getSurveyInstancesBulk()
Usage
CastorData$getSurveyInstancesBulk(
study_id_,
participant_id_ = NULL,
id_to_field_name_ = NULL
)
Method getSurveyInstanceBulk()
Usage
CastorData$getSurveyInstanceBulk(study_id, participant_id, survey_instance_id)
Method getSurveyPackageInstanceBulk()
Usage
CastorData$getSurveyPackageInstanceBulk(
study_id,
participant_id,
survey_package_instance_id
)
Method getStudyDataPoints()
Usage
CastorData$getStudyDataPoints(
study_id,
participant_id = NULL,
filter_types = NULL,
bulk_by_participant = FALSE
)
Method getStudyDataBulk()
Usage
CastorData$getStudyDataBulk(study_id., field_info., participant_metadata)
Method getFieldInfo()
Usage
CastorData$getFieldInfo(study_id)
Method generateFieldMetadata()
Usage
CastorData$generateFieldMetadata(study_id, field_info)
Method getStudyData()
Usage
CastorData$getStudyData(
study_id,
bulk = TRUE,
load_study_data = TRUE,
repeating_data_instances = TRUE,
survey_instances = TRUE,
translate_option_values = TRUE,
filter_types = c("remark", "image", "summary", "upload", "repeated_measures",
"add_repeating_data_button")
)
Method generateCheckboxFields()
Usage
CastorData$generateCheckboxFields(field_info, checkboxes = NULL)
Method adjustCheckboxFields()
Usage
CastorData$adjustCheckboxFields(datapoints, field_info, checkbox_fields = NULL)
Method adjustTypes()
Usage
CastorData$adjustTypes(study_data, field_metadata, type_to_func, filter_types)
Method transformOptionGroups()
Usage
CastorData$transformOptionGroups(dataframe, study_id)
Method clone()
The objects of this class are cloneable with this method.
Usage
CastorData$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
castoredc/castoRedc documentation built on Aug. 4, 2024, 5:24 a.m.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
| CastorData-class | R Documentation |
Class used to access Castor REST API.
Description
Class used to access Castor REST API.
Class used to access Castor REST API.
Format
An R6 class object.
Methods
-
getStudies(): Retries all Castor studies in account. -
getFields(study_id, include, page): Gets all fields for a given study. -
getParticipants(study_id): Gets all participants for a given study. -
getStudyDataPoints(study_id, participant_id, filter_types): Gets all data points for a given study and participant. Filter types may be supplied for fields types as a character vector of field types. -
getStudyData(study_id, load_study_data, repeating_data_instances, survey_instances, translate_option_values, filter_types): creates a named nested list with a dataframe for all study data, a list of dataframes for repeating data instances and a list of dataframes for survey instances. Can toggle which data is extracted, and whether option group values are translated to labels. -
getOptionGroups(study_id): creates a data frame with all option groups for a given study with each row representing an option group. -
getRepeatingDataInstancesByParticipant(study_id, participant_id): creates a data frame with all repeating data for a given participant with each row representing a field. -
adjustTypes = function(field_to_type, values, type_to_func): Utility method for casting columns to their intended type. Users can supply their own list of data type : function (for casting the data) mappings on instantiation of this class, CastorAPIWrapper. -
transformOptionGroups = function(dataframe, study_id): Utility method for transforming a dataframe with option group values to the correct labels.
Super class
castoRedc::CastorAPIWrapper -> CastorData
Methods
Public methods
Inherited methods
castoRedc::CastorAPIWrapper$castorOAuth()castoRedc::CastorAPIWrapper$collectPages()castoRedc::CastorAPIWrapper$getField()castoRedc::CastorAPIWrapper$getFieldsPages()castoRedc::CastorAPIWrapper$getForm()castoRedc::CastorAPIWrapper$getFormsPages()castoRedc::CastorAPIWrapper$getParticipant()castoRedc::CastorAPIWrapper$getParticipantsPages()castoRedc::CastorAPIWrapper$getRepeatingData()castoRedc::CastorAPIWrapper$getRepeatingDataForm()castoRedc::CastorAPIWrapper$getRepeatingDataFormsPages()castoRedc::CastorAPIWrapper$getRepeatingDataInstanceMetadataPages()castoRedc::CastorAPIWrapper$getRepeatingDatasPages()castoRedc::CastorAPIWrapper$getRequest()castoRedc::CastorAPIWrapper$getStudiesPages()castoRedc::CastorAPIWrapper$getStudy()castoRedc::CastorAPIWrapper$getStudyDataPoint()castoRedc::CastorAPIWrapper$getStudyDataPointsPages()castoRedc::CastorAPIWrapper$getSurvey()castoRedc::CastorAPIWrapper$getSurveyPackage()castoRedc::CastorAPIWrapper$getSurveyPackageInstance()castoRedc::CastorAPIWrapper$getSurveyPackageInstancesPages()castoRedc::CastorAPIWrapper$getSurveyPackagesPages()castoRedc::CastorAPIWrapper$getSurveysPages()castoRedc::CastorAPIWrapper$getUsersPages()castoRedc::CastorAPIWrapper$getVisit()castoRedc::CastorAPIWrapper$getVisitsPages()castoRedc::CastorAPIWrapper$initialize()
Method getStudies()
Usage
CastorData$getStudies()
Method getUsers()
Usage
CastorData$getUsers()
Method getForms()
Usage
CastorData$getForms(study_id)
Method getFields()
Usage
CastorData$getFields(study_id, include = "optiongroup")
Method getVisits()
Usage
CastorData$getVisits(study_id)
Method getSurveys()
Usage
CastorData$getSurveys(study_id, include = "forms", page = NULL)
Method getSurveyPackages()
Usage
CastorData$getSurveyPackages(study_id)
Method getSurveyPackageInstances()
Usage
CastorData$getSurveyPackageInstances(study_id)
Method getRepeatingDatas()
Usage
CastorData$getRepeatingDatas(study_id)
Method getRepeatingDataForms()
Usage
CastorData$getRepeatingDataForms(study_id)
Method getParticipants()
Usage
CastorData$getParticipants(study_id, filter_archived = TRUE)
Method getStudyDataPointsBulkByParticipant()
Usage
CastorData$getStudyDataPointsBulkByParticipant(study_id, participant_id)
Method getStudyDataPointsBulk()
Usage
CastorData$getStudyDataPointsBulk(study_id_ = FALSE)
Method getOptionGroups()
Usage
CastorData$getOptionGroups(study_id = FALSE)
Method getRepeatingDataInstancesByParticipant()
Usage
CastorData$getRepeatingDataInstancesByParticipant(study_id, participant_id)
Method getRepeatingDataInstances()
Usage
CastorData$getRepeatingDataInstances( study_id, participant_id = NULL, id_to_field_name = NULL )
Method getRepeatingDataInstancesBulk()
Usage
CastorData$getRepeatingDataInstancesBulk( study_id_, participant_id_ = NULL, id_to_field_name_ = NULL, page_size = NULL )
Method getRepeatingDataInstanceMetadata()
Usage
CastorData$getRepeatingDataInstanceMetadata(study_id)
Method getSurveyInstances()
Usage
CastorData$getSurveyInstances( study_id, participant_id = NULL, id_to_field_name = NULL )
Method getSurveyInstancesBulk()
Usage
CastorData$getSurveyInstancesBulk( study_id_, participant_id_ = NULL, id_to_field_name_ = NULL )
Method getSurveyInstanceBulk()
Usage
CastorData$getSurveyInstanceBulk(study_id, participant_id, survey_instance_id)
Method getSurveyPackageInstanceBulk()
Usage
CastorData$getSurveyPackageInstanceBulk( study_id, participant_id, survey_package_instance_id )
Method getStudyDataPoints()
Usage
CastorData$getStudyDataPoints( study_id, participant_id = NULL, filter_types = NULL, bulk_by_participant = FALSE )
Method getStudyDataBulk()
Usage
CastorData$getStudyDataBulk(study_id., field_info., participant_metadata)
Method getFieldInfo()
Usage
CastorData$getFieldInfo(study_id)
Method generateFieldMetadata()
Usage
CastorData$generateFieldMetadata(study_id, field_info)
Method getStudyData()
Usage
CastorData$getStudyData(
study_id,
bulk = TRUE,
load_study_data = TRUE,
repeating_data_instances = TRUE,
survey_instances = TRUE,
translate_option_values = TRUE,
filter_types = c("remark", "image", "summary", "upload", "repeated_measures",
"add_repeating_data_button")
)Method generateCheckboxFields()
Usage
CastorData$generateCheckboxFields(field_info, checkboxes = NULL)
Method adjustCheckboxFields()
Usage
CastorData$adjustCheckboxFields(datapoints, field_info, checkbox_fields = NULL)
Method adjustTypes()
Usage
CastorData$adjustTypes(study_data, field_metadata, type_to_func, filter_types)
Method transformOptionGroups()
Usage
CastorData$transformOptionGroups(dataframe, study_id)
Method clone()
The objects of this class are cloneable with this method.
Usage
CastorData$clone(deep = FALSE)
Arguments
deepWhether to make a deep clone.
R Package Documentation
Browse R Packages
We want your feedback!
Note that we can't provide technical support on individual packages. You should contact the package authors for that.
Embedding an R snippet on your website
Add the following code to your website.
For more information on customizing the embed code, read Embedding Snippets.