| Line 1: |
Line 1: |
| | + | [[Category:RAREMETAL]] |
| | + | [[Category:RAREMETALWORKER]] |
| | == Useful Wiki Pages == | | == Useful Wiki Pages == |
| | | | |
| Line 6: |
Line 8: |
| | * The [[RAREMETAL_Change_Log | '''Change Log''']] | | * The [[RAREMETAL_Change_Log | '''Change Log''']] |
| | | | |
| − | == Where to Download == | + | ===GitHub=== |
| | | | |
| − | * University of Michigan CSG users can go to the following:
| + | All source code is available on GitHub: |
| − | /net/wonderland/home/saichen/Raremetal/
| |
| | | | |
| − | ===GIT HUB===
| + | https://github.com/statgen/Raremetal |
| | | | |
| − | Please clone or download from GitHub:
| + | See README.md for instructions on how to compile RAREMETAL for your environment. It should be possible to compile in Mac OS and Linux environments. You will need '''Cmake''' and '''Cget''' available. |
| | | | |
| − | https://github.com/statgen/Raremetal
| + | Since version 4.13.6, RAREMETALWORKER and RAREMETAL are distributed within the same package in this repository. More information on changes may be found at our [https://github.com/statgen/raremetal/releases releases page]. |
| − | | |
| − | <span style="color:#FF0000">There is a known issue with the newest versions (>=4.14.0) of RAREMETAL, which may give incorrect p-values for some burden test calculation methods. We are working on a fix, but for now we recommend using an older version (<= 4.13.9).</span>
| |
| − | | |
| − | Since v4.13.6, MAC and WINDOWS version are no longer updated. Please download old versions from here: | |
| − | | |
| − | * [[Media:MAC_raremetal.4.13.6.tgz |'''for MAC OS X''']]
| |
| − | | |
| − | * [[Media:CYGWIN64_raremetal.4.13.6.tgz |'''for Windows/CygWin64''']]
| |
| − | | |
| − | * [[Media:MINGW_raremetal.4.13.6.tgz |'''for Windows/MinGW''']]
| |
| − | | |
| − | From version 4.13.6, RAREMETALWORKER and RAREMETAL are distributed within the same package.
| |
| | | | |
| | ===SCRIPTS=== | | ===SCRIPTS=== |
| Line 34: |
Line 23: |
| | *If you want to estimate '''Odds Ratios''' of variants analyzed by RAREMETALWORKER, the script [[Media:CalculateOddsRatio.tgz|'''calculateOddsRatio.pl''']] can help you augment RAREMETALWORKER output with estimated odds ratio to the last column. | | *If you want to estimate '''Odds Ratios''' of variants analyzed by RAREMETALWORKER, the script [[Media:CalculateOddsRatio.tgz|'''calculateOddsRatio.pl''']] can help you augment RAREMETALWORKER output with estimated odds ratio to the last column. |
| | *The script can also be found in the RAREMETAL package 4.13.6 and later, under directory '''raremetal/script/calculateOddsRatio.pl'''. | | *The script can also be found in the RAREMETAL package 4.13.6 and later, under directory '''raremetal/script/calculateOddsRatio.pl'''. |
| − |
| |
| − | == How to Compile ==
| |
| − |
| |
| − | * gfortran is necessary to build RAREMETAL. If your system does not have it yet, please go to [http://gcc.gnu.org/wiki/GFortranBinaries '''GNU gfortran'''] for download.
| |
| − |
| |
| − | * If you prefer to build from scratch, then do the following in your Raremetal directory:
| |
| − | prompt> make clean
| |
| − | prompt> make
| |
| − | #This builds RAREMETAL and RAREMETALWORKER under bin/ directory.
| |
| − |
| |
| − | * If you prefer to build individual tool:
| |
| − | prompt> cd Raremetal/raremetalworker/
| |
| − | prompt> make
| |
| − | #This will build RAREMETALWORKER under raremetal/bin/ directory.
| |
| − |
| |
| − | prompt> cd Raremetal/raremetal/
| |
| − | prompt> make
| |
| − | #This will build RAREMETAL under raremetal/bin/ directory.
| |
| − |
| |
| − | * If your compiler is adaptable to openmp (parallel computing), then use the following to build RAREMETALWORKER that allows parallel computing. For more about openmp, please refer to [http://openmp.org/wp/openmp-compilers/ openMP].
| |
| − | prompt> cd raremetalworker/src
| |
| − | prompt> make openmp
| |
| − | #This will build RAREMETALWORKER under raremetal/bin/ directory.
| |
| − |
| |
| − | * If you prefer to use the binary file downloaded above, then no compiling is needed, but it is not guaranteed to work due to system and library requirements.
| |
| − |
| |
| − | ==FAQ==
| |
| − |
| |
| − | For compiling questions, please go to [http://genome.sph.umich.edu/wiki/RAREMETAL_FAQ ''' FAQ'''] for more information.
| |
| − |
| |
| − | ==OLD VERSIONS==
| |
| − | (All linux versions)
| |
| − | * [[Media:Raremetal.4.13.8.tar.gz |'''v4.13.8''']]
| |
| − | * [[Media:Raremetal.4.13.6.tar.gz |'''v4.13.6''']]
| |
