palinear(1)

๐Ÿ’– palinear(1) โ€” the linear-model GWAS girlie ๐Ÿ’–

okay so bestie, welcome to palinear, from the General Commands Manual section. she's giving "run a whole genome-wide association analysis and make it look easy" โœจ


๐ŸŒธ NAME ๐ŸŒธ

palinear โ€” Perform Genome-Wide Association Analysis using a linear model ๐Ÿงฌ


โœจ SYNOPSIS โœจ

palinear [ command-line options ]

that's it. that's the whole vibe. you hand her options, she hands you regression results ๐Ÿ’…


๐Ÿฆ‹ DESCRIPTION ๐Ÿฆ‹

palinear runs a linear regression on large imputed data sets, and she does it in an efficient way. no cap. big data, tiny runtime, main character energy fr fr ๐Ÿ”ฅ


๐ŸŽ€ Options ๐ŸŽ€

๐Ÿ’œ Required command line options ๐Ÿ’œ

these ones? not optional. she needs them. periodt.

  • -p, --pheno FILE โ€” Read phenotype data from FILE. like, the actual thing you're studying bestie, can't regress on nothing ๐Ÿ™ˆ
  • -i, --info FILE โ€” Read SNP information from FILE (e.g. MLINFO file). the SNP lore goes here ๐Ÿ“‹
  • -d, --dose FILE โ€” SNP predictor (e.g. MLDOSE/MLPROB) file name. the actual dosage/probability data, the star of the show ๐Ÿ‘‘

๐ŸŒˆ Optional command line options ๐ŸŒˆ

these are the "if you want" girlies. she works without them, but they make her shine โœจ

  • -m, --map FILE โ€” Map file name, containing base pair positions for each SNP. where each SNP lives on the chromosome, geographically speaking ๐Ÿ—บ๏ธ
  • -n, --nids NUMBER โ€” Number of people to analyse. how many besties are in the study ๐Ÿซถ
  • -c, --chrom FILE โ€” Chromosome (to be passed to output). she just forwards it straight to the output, no thoughts, head empty, iconic ๐Ÿ’…
  • -o, --out FILE โ€” Output file name (default is regression.out.txt). where the receipts go ๐Ÿงพ
  • -s, --skipd NUMBER โ€” How many columns to skip in predictor (dose/prob) file (default is 2). skip past the boring leading columns like they're an ex ๐Ÿšถโ€โ™€๏ธ
  • -t, --ntraits NUMBER โ€” How many traits are analysed (default is 1). multitasking queen ๐Ÿ’…
  • -g, --ngpreds NUMBER โ€” How many predictor columns per marker (default 1 = MLDOSE; else use 2 for MLPROB). one column of dosage or two of probability, pick your fighter ๐ŸฅŠ
  • -a, --separat CHAR โ€” Use character CHAR to separate fields in the output file(s) (default is space). choose your delimiter, customize your life ๐ŸŽ€
  • -r, --score โ€” Use the score test. score test era โญ
  • -e, --no-head โ€” Do not report header line in the output. no header, we die like women (metaphorically, it's just a missing line) ๐Ÿ’€
  • -f, --flipmaf โ€” Flip reference and effect allele according to Minor Allele Frequency (MAF) such that the minor allele is the effect/predictor allele. If this option is set, ProbABEL will check for each genetic variant whether the Freq1 column in the info file (see the --info option) is > 0.5 and if so will flip the probabilities/dosage of that variant such that A1 and A2 are interchanged. This will add a column called AllelesFlipped to the output file(s), indicating whether the alleles were flipped (1) or not (0). okay this one is a whole paragraph but she's worth it โ€” the minor allele takes the spotlight, and you get a whole AllelesFlipped column to prove it ๐Ÿ”„
  • -l, --allcov โ€” Report estimates for all covariates (large outputs!). heads up bestie, this makes the output BIG โ€” she literally put the exclamation mark in there herself ๐Ÿ˜ญ
  • -b, --interaction NUMBER โ€” Which covariate to use for interaction with SNP analysis (default is no interaction, 0). NUMBER indicates the column number of the covariate. tell her which covariate wants to interact with the SNP, by column number ๐Ÿค
  • -v, --mmscore FILE โ€” Score test in samples of related individuals. The FILE argument is the name of a file with the inverse of the variance-covariance matrix. related individuals? she's got a matrix for that (the inverse one, specifically) ๐Ÿงฎ
  • -u, --robust โ€” Report robust (a.k.a. sandwich, a.k.a. Hubert-White) standard errors. sandwich errors?? we love a well-fed standard error ๐Ÿฅช
  • --help โ€” Print help. when in doubt, ask her directly ๐Ÿซถ

๐Ÿ‘€ SEE ALSO ๐Ÿ‘€

go hang out with her sisters:


๐Ÿ’€ BUGS ๐Ÿ’€

found a bug? do not suffer in silence. The bugtracker is located at:

https://github.com/GenABEL-Project/ProbABEL/issues

go tell them, they'll fix it, slay ๐Ÿ›๐Ÿ”จ


๐Ÿ‘‘ AUTHORS ๐Ÿ‘‘

Lennart C. Karssen โ€” thank you for your service, legend ๐Ÿซก๐Ÿ’–


and that's the whole page bestie!! this manual is from ProbABEL 0.5.0, dated 4 May 2016, and yeah she's a little vintage but she's still iconic and she still runs your GWAS โœจ๐Ÿงฌ๐Ÿ’… bye babes, go run some regressions ๐ŸŒˆ๐Ÿ’–