Skip to content

Home

Jump to bottom
edambo edited this page Mar 8, 2024 · 12 revisions

This page describes the organization of the files in the detect_fu_interviews_public repository. This information can be used to navigate and appropriately modify folders and files.

Page contents

Folder structure

  • codebooks: This folder contains the codebooks for the F/U interview data frames. It also contains the code used to create the codebooks.

    • variable_descriptions: This folder contains RDS files of variable names and descriptions extracted from the codebook attributes.

  • data: This folder contains data files (e.g., csv, Rds).

  • data_management: This folder contains code files used to import, clean, and transform the F/U interview data.

    • qaqc: This folder contains code files used to check the quality of the data.
    • unique_person_identification: This folder contains code files used to create unique person identifiers.

  • docs: This folder contains Word, PDF, and other documents that aren't direct inputs to, or outputs of, any data management or analysis code, but they do provide context or other useful information.

  • exploratory: This folder contains code for minor one-off and exploratory analyses.

  • r: This folder contains R scripts. Typically, R scripts are only used for writing custom functions.

What do all the code files in this repository do? {#files}

In general, you won't be able to do much with the files in this repository without the DETECT Follow-Up Interviews data. So, if you haven't already, you will need to download the DETECT data to your computer. Below are descriptions for the purposes of each of the files in this repository:

  • data_management folder

    • data_01_aps_investigations_import.qmd -  Cleans the APS investigations dataset and creates an RDS file containing the cleaned data.

    • data_02_consent_import.qmd - Cleans the consent dataset and creates an RDS file containing the cleaned data.

    • data_03_clutter_scale_import.qmd -  Cleans the clutter scale dataset and creates an RDS file containing the cleaned data.

    • data_04_general_health_import.qmd -  Cleans the general health dataset and creates an RDS file containing the cleaned data.

    • data_05_observational_measures_import.qmd - Cleans the observational measures dataset and creates an RDS file containing the cleaned data.

    • data_06_self-report_import.qmd - Cleans the self-report dataset and creates an RDS file containing the cleaned data.

    • data_07_sociodemographic_information_import.qmd - Cleans the sociodemographic information dataset and creates an RDS file containing the cleaned data.

    • data_08_lead_panel_assessment_import.qmd - Cleans the LEAD panel assessment dataset and creates an RDS file containing the cleaned data.

    • data_09_participant_import.qmd - Cleans the participant dataset and creates an RDS file containing the cleaned data.

    • data_10_merged_detect_fu_data.qmd - Combines all the DETECT Follow-Up data sets into a single one that can be used for analysis. This combined data set can be used with the code in the custom function file extract_df_from_merged_detect.R.

  • codebooks folder

    • data_01_aps_investigations_codebook.qmd - Creates codebook for the APS investigations dataset using the RDS file generated by data_02_aps_investigations_import.qmd.

    • data_03_clutter_scale_codebook.qmd - Creates codebook for the clutter scale dataset using the RDS file generated by data_03_clutter_scale_import.qmd.

    • data_04_general_health_codebook.qmd - Creates codebook for the general health dataset using the RDS file generated by data_04_general_health_import.qmd.

    • data_05_observational_measures_codebook.qmd - Creates codebook for the observational measures dataset using the RDS file generated by data_05_observational_measures_import.qmd.

    • data_06_self_report_codebook.qmd - Creates codebook for the self-report dataset using the RDS file generated by data_06_self-report_import.qmd.

    • data_07_sociodemographic_information_codebook.qmd - Creates codebook for the self-report dataset using the RDS file generated by data_07_sociodemographic_information_import.qmd.

    • data_08_lead_panel_assessment_codebook.qmd - Creates codebook for the LEAD panel assessment dataset using the RDS file generated by data_08_lead_panel_assesment_import.qmd.

    • data_09_participant_codebook.qmd - Creates codebook for the participant dataset using the RDS file generated by data_09_participant_import.qmd.

    • data_10_merged_detect_fu_data_codebook.qmd - Creates codebook for the merged data set using the RDS file generated by data_10_merged_detect_fu_data.qmd.

Top

File naming conventions

  • Separate data cleaning and data analysis into separate Rmd files.

    • Data cleaning files should be named:
      • data_[order number]_[purpose]
      • Example: data_03_prep_for_sna
    • Analysis files that do not directly create a table or figure should be named:
      • analysis_[order number]_[brief summary of content]
      • Example: analysis_01_exploratory
    • Analysis files that DO directly create a table or figure should be named:
      • table_[brief summary of content] or
      • fig_[brief summary of content]
      • Example: table_network_characteristics

  • Images should be png and should be saved to the img folder and given a descriptive name.

  • Word and pdf files should be saved to the docs folder and given a descriptive name.

  • RDS, RData, CSV, Excel, etc. files should be saved to the data folder and given a descriptive name.

Clone this wiki locally