[FEATURE] Implement a function to return project-wide metadata

[rsh52]

Feature Request Description

REDCapTidieR should have a function to return project-wide metadata, arranged in a tidy tibble.

Proposed Solution

Similar to read_redcap_tidy() output, we could look into making a read_redcap_metadata_tidy() function that returns a tibble. This tibble will probably have one row and include the following columns:

• project_type: longitudinal or classic
• arms: a tibble of arms and arm names, generated by REDCapR::redcap_arms. Skip if project doesn't have arms
• events: a tibble of event/instrument mappings, generated by REDCapR::redcap_event_instruments
• users: a tibble of users and project-wide permissions, generated by REDCapR::redcap_users_export (from $data object)
• user_form_permissions: a tibble of users and instrument-specific permissions, generated by REDCapR::redcap_users_export (from $data_user_form object)
• dags: a tibble of DAGs, generated by REDCapR::redcap_dag_read
• version: the version of the REDCap instance, generated by REDCapR::redcap_version

Note: dag, users and user_form_permissions may contain sensitive information. I would suggest adding a toggle pull_user_info as a function argument, setting the default to FALSE.

More to be added as determined.

Alternatives considered

Metadata could be returned by the read_redcap_tidy function. However, this may be awkward for metadata that is not instrument specific.

Checklist

• The issue is atomic
• The issue description is documented
• The issue title describes the problem succinctly
• Developers are assigned to the issue
• Labels are assigned to the issue

[skadauke]

It would be nice to also have the project title and project PID in this table. This will require a call to the "Export Project Information" method, for which there currently isn't a wrapper implemented in REDCapR. However, I've found that I can implement a minimal wrapper like this:

post_body <- 
  list(
    token = token,
    content = "project",
    format = "csv"
  )

kernel <- REDCapR:::kernel_api(redcap_uri, post_body, config_options = NULL)

d <- readr::read_csv(I(kernel$raw_text))

We could either contribute the wrapper to REDCapR or use the above code.

[skadauke]

It would be nice to also have the project title and project PID in this table. This will require a call to the "Export Project Information" method, for which there currently isn't a wrapper implemented in REDCapR. However, I've found that I can implement a minimal wrapper like this:

post_body <- 
  list(
    token = token,
    content = "project",
    format = "csv"
  )

kernel <- REDCapR:::kernel_api(redcap_uri, post_body, config_options = NULL)

d <- readr::read_csv(I(kernel$raw_text))

We could either contribute the wrapper to REDCapR or use the above code.

Sounds like Will is going to implement a wrapper inside REDCapR. Let's wait for it.

[skadauke]

See also this REDCapR issue