README.md

In explodecomputer/alspac: Data dictionary for ALSPAC

ALSPAC data interface

Table of contents Motivation Limitations Credits etc Installation Finding variables Extracting variables Using the website to browse variables Dictionary Maintenance * Generating datasets for external users

Motivation

To obtain ALSPAC variables, the general procedure is:

1. search through PDFs to find the variable(s)
2. search through STATA files to extract
3. load into R files to use

This package combines the search and extraction procedure into two functions, this makes the work a bit more reproducible. It works for the curated data in the R:/Current/ directory.

The extracted data has withdrawn consent individuals removed automatically.

You can browse the variables here: http://variables.alspac.bris.ac.uk/

Limitations

• The data is not curated further than what is present already in the STATA .dta files
• This is a beta version of the package, please report errors or suggestions to [e-mail]
• Variable look-ups can be performed off-line and without any restrictions, but variable extraction requires access to the R drive where the data is residing.
• ALN IDs refer to pregnancies. The same ALN is shared between mothers, their children, partners and fathers. Children can be distinguished from the others by virtue of having a QLET code. But distinguishing between mothers, fathers and partners is not straightforward. See note below on how data that includes different individuals with the same ALN is presented.

Credits etc

Please report issues or suggestions to Gibran Hemani. Thanks to Tom Gaunt, Matt Suderman, Andrew Simpkin, Paul Yousefi, ALSPAC team for help in developing this package.

Installation

To install the latest version:

install.packages("remotes")
remotes::install_github("explodecomputer/alspac")

The alspac package can then be loaded as follows:

library(alspac)

Finding variables

Browsing the variables manually

There is one data object that comes with the package - current - that contains all the variables available in the R:/Current/ directory. It can be searched manually after loading it directly:

data(current)

The top 6 rows of current look like this:

   obj name                   lab counts    type    cat1  cat2   cat3 cat4         path
1 a_3c  aln  Pregnancy identifier  13545 integer Current Quest Mother <NA> Current/Quest/Mother
2 a_3c a001 Questionnaire version  13545  factor Current Quest Mother <NA> Current/Quest/Mother
3 a_3c a002    Time lived in Avon  13545  factor Current Quest Mother <NA> Current/Quest/Mother
4 a_3c a003 Years since last move  13545 integer Current Quest Mother <NA> Current/Quest/Mother
5 a_3c a004 Weeks since last move  13545 integer Current Quest Mother <NA> Current/Quest/Mother
6 a_3c a005  NO of moves in 5 YRS  13545 integer Current Quest Mother <NA> Current/Quest/Mother

• obj is the filename
• name is the variable name
• lab is the description of the variable
• counts is the number of non-missing values
• type is the data type
• cat1-cat4 are the folder names in which the object is found, used here loosely as categories for the data
• path is the path to the obj file

Using the search function

A simple search function findVars is a simple helper for searching current (default). Documentation can be retrieved using:

?findVars

For example, to search for all variables with the word 'height' in the description from the current data:

vars <- findVars("height")

If I want any with height OR length in the description then:

vars <- findVars("height", "length", logic="any", whole.word=TRUE, ignore.case=TRUE)

If I want any with height AND length:

vars <- findVars("height", "length", logic="and", whole.word=TRUE, ignore.case=TRUE)

If I want to find anything with sleep somewhere (not necessarily a whole word) I might do:

vars <- findVars("sleep", "slept", logic="any", whole.word=FALSE, ignore.case=TRUE)

Some of these arguments have defaults but just writing them out for illustration.

Filtering a list of variables

findVars may identify multiple variables with the same name.

For example, searching for variables "kz021", "kz011b" and "c645a" will return multiple variables with the same name.

varnames <- c("kz021","kz011b","ype9670", "c645a")
vars <- findVars(varnames)

There are two ways to select among these duplicates.

1. Manually select rows corresponding to variables that I want, e.g.

vars <- vars[vars$name=="kz021" & startsWith(vars$obj,"cp")
        | vars$name=="kz011b" & startsWith(vars$obj,"cp")
        | vars$name=="c645a" & vars$cat2=="Quest"
        | vars$name=="YPE9670",]

In other words, I require that the "kz021" variable come from a STATA file name starting with "kz" ("obj" column in vars), "kz011b" comes from a file name starting with "cp" and the description of the variable ("lab" column in vars) include the word "Participant", and "c645a" comes from a questionnaire ("cat2" column in vars).

1. Apply filterVars.

As a first clean-up step, I remove any variables whose names do not exactly match one of the variable names I am looking for.

vars <- subset(vars, subset=tolower(name) %in% varnames)

I then use filterVars to select variables satisfying the criteria described above.

vars <- filterVars(vars,
        kz021=c(obj="^kz"),
        kz011b=c(obj="^cp", lab="Participant"),
        c645a=c(cat2="Quest")) 

Extracting variables

To extract the data corresponding to this selection of variables, I need to have mounted the R:/Data drive on my computer. When I load the package (library(alspac)), if I have the R drive loaded then I should get a message like this:

The data directory has been recognised

Sometimes this might not work - the package tries to guess where the R drive will be mounted but it might guess wrong. If I receive an error message instead, then I need to specify the location of the R drive manually:

setDataDir("/path/to/R drive/data/") ## e.g. setDataDir("//ads.bris.ac.uk/filestore/SSCM ALSPAC/Data")

Once I have received the message The data directory has been recognised, I am able to extract the variables I need from the R drive.

results <- extractVars(vars)

Important note on IDs

Suppose I extract a variable measured in each of mothers, children, fathers and partners. e.g.

x <- subset(current, name %in% c("cf010", "ff1a005a", "fm1a010a", "pc013"))
y <- extractVars(x)

returning e.g.

> head(y, 4)
   alnqlet   aln qlet cf010 mult_dad ff1a005a mult_mum fm1a010a pc013
1    50013 50013 <NA>    NA     <NA>       NA     <NA>       NA     2
2    50050 50050 <NA>    NA     <NA>       NA     <NA>       NA     2
3    60052 60052 <NA>    NA     <NA>       NA     <NA>       NA     2
4    90020 90020 <NA>    NA       No        7       No        4     2

This has returned the variables requested, along with some other columns -

• aln - This is the pregnancy identifier. NOTE - this is not an individual identifier. For example, notice that row 4 has entries for the father variable ff1a005a, the mother variable fm1a010a, and the partner variable pc013.
• qlet - This is the child ID for the specific pregnancy. It will take values from A-D. All children will have a qlet, and only children will have a qlet. Therefore if qlet is not NA, that row represents an individual child.
• alnqlet this is the ALN + QLET. If the individual is a child (e.g. row 8) then they will have a different alnqlet compared to the aln. Otherwise, the aln is the same as the alnqlet

• mult_mum and mult_dad - Sometimes the same mother (or father) had more than one pregnancy in the 18 month recruitment period. Those individuals have two ALNs. If either of these columns is "Yes" then that means you can drop them from the results if you want to avoid individuals being duplicated. This is the guidance from the FOM2 documentation:

  1.7 Important Note for all data users

  Please be aware that some women may appear in the release file more than once. This is due to the way in which women were originally enrolled into the study and were assigned IDs. ALSPAC started by enrolling pregnant women and the main study ID is a pregnancy based ID. Therefore if a women enrolled with two different pregnancies (both having an expected delivery date within the recruitment period [April 1991-December 1992]), she will have two separate IDs to uniquely identify these women and their pregnancies. An indicator variable has been included in the file, called mult_mum to identify these women. If you are carrying out mother based research that does not require you to consider repeat pregnancies for which we have data then please select mult_mum == 'No' to remove the duplicate entries. This will keep one pregnancy and randomly drop the other pregnancy. If you are matching the data included in this file to child based data or have been provided with a dataset that includes the children of the ALSPAC pregnancies, as well as the mother-based data, you need not do anything as each pregnancy (and hence each child from a separate pregnancy) has a unique identifier and a mothers’ data has been included/repeated here for each of her pregnancies where appropriate.

If you have a better way to present these data do contact me.

Using the website to browse variables

Variables can be browsed at https://alspac-example.shinyapps.io/alspac-dt/. This contains the 'Current' variables.

This site can also be used to select variables for extraction:

1. Select the variables of interest from the table, then click 'Download variable list'. This will download a csv file containing information about the variables chosen.
2. Next, use the extractWebOutput function in the alspac package to extract the variables, specifying the name of the file that you just downloaded. For example

extractWebOutput("data-2017-08-22.csv")

To code for the shiny variable app is here: https://github.com/explodecomputer/alspac-shiny

Dictionary Maintenance

From time to time the R:\Data\Current\ directory is updated with new files. The variable dictionaries that the package uses can be updated using the updateDictionaries() function.

updateDictionaries()

This will take a few minutes to run. These updated dictionaries will be saved within the R package for use in later R sessions. In other words, an update will only need to be peformed one time.

Generating datasets for external users (for ALSPAC data buddies)

The extractDataset function can be used to generate datasets with id-swaps for external users from the following inputs: a csv file listing variables (variable_file, e.g. "variables.csv" with a column "Name" containing variable names) a csv file defining the id-swap (cid_file, e.g. "ACEHDBFG.txt", with columns "ALN" and "G" -- the last character in the filename) format of the requested output (output_format which can be either "sav", "csv" or "dta") B number of the project proposal (b_number, e.g. "B0001") * last name of the project lead (author, e.g. "Smith")

The function will create the dataset as requested and save it to a file in the current directory with a name like "Smith_B0001_16Jul21.sav" derived from the inputs to the function.

library(alspac)

setDataDir("R:/SSCM ALSPAC/Data") 
## or possibly setDataDir("//ads.bris.ac.uk/filestore/SSCM ALSPAC/Data")

dat <- extractDataset(
    variable_file="inputs/variables.csv",
    cid_file="inputs/ACEHDBFG.txt",
    output_format="sav",
    b_number="B0001",author="Smith")

explodecomputer/alspac documentation built on Feb. 16, 2024, 4:18 p.m.