fluidigm2PLINK {Fluidigm}

Convert Fluidigm Output to 'PLINK' Format

Description

This function takes a Fluidigm output file and converts it into a 'PLINK' format. The 'PLINK' ped/map format is a widely used genetic variation data format. This function is useful for researchers who want to analyze Fluidigm data using tools that accept 'PLINK' format.

Usage

fluidigm2PLINK(
  file = NA,
  map = NA,
  out = NA,
  outdir = NA,
  plots = TRUE,
  rearrange = TRUE,
  missing.geno = "0 0",
  fixNames = TRUE,
  overwrite = FALSE,
  verbose = TRUE,
  verbosity = 1
)

Arguments

file

A string specifying the path to the input file in CSV format.

map

A string specifying the filepath to the map-file that should be used.

out

A string specifying the output file name. If left empty, the original basename of the input file will be used.

outdir

A string specifying the output folder. If left empty the original folder path of the input file will be used.

plots

A logical indicating whether additional figures for conversion should be plotted. Default is TRUE.

rearrange

A logical indicating whether the ped/map output should be rearranged in order of provided map file. Default is TRUE.

missing.geno

A character string specifying how missing values should be coded. Default is "0 0".

fixNames

A logical indicating whether whitespaces from sample names should be automatically removed. Default is TRUE.

overwrite

A logical indicating wheter the original map file should be overwritten or not. Default FALSE

verbose

A logical or numerical value indicating whether the output should be verbose. Default is TRUE.

verbosity

A numerical value indicating the level of verbosity. Set to a higher number for more details. Default is 1.

Details

The function first checks the input parameters and then imports the Fluidigm data from the CSV file. It creates a new MAP file based on the information provided in the given map file. The function then creates a PED file and exports both files. If requested, the function also generates plots for genotyping success and additional summary statistics.

This function uses the PLINK software. For more information about PLINK, please refer to the official documentation.

Value

A ped/map file pair and optional diagnostic plots.

References

PLINK: Whole genome data analysis toolset - Harvard University

Examples

  file_path_csv <- system.file("extdata", "example_data.csv", package = "Fluidigm")
  file_path_map <- system.file("extdata", "example_data_withY.map", package = "Fluidigm")
  outdir <- tempdir()

  fluidigm2PLINK(file=file_path_csv, map=file_path_map, outdir=outdir)