diff --git a/installer/resources/core/RTGOperationsManual.pdf b/installer/resources/core/RTGOperationsManual.pdf index 45b5938f4..e517a8d1f 100644 Binary files a/installer/resources/core/RTGOperationsManual.pdf and b/installer/resources/core/RTGOperationsManual.pdf differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/00b47fa9220275347363dd17597c6ce4efc96fa5.png b/installer/resources/core/RTGOperationsManual/_images/math/00b47fa9220275347363dd17597c6ce4efc96fa5.png new file mode 100644 index 000000000..ae9335d8e Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/00b47fa9220275347363dd17597c6ce4efc96fa5.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/0118ce53bf328bf7fa4d2751f727ce6ed1a759fd.png b/installer/resources/core/RTGOperationsManual/_images/math/0118ce53bf328bf7fa4d2751f727ce6ed1a759fd.png new file mode 100644 index 000000000..0bd0247a0 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/0118ce53bf328bf7fa4d2751f727ce6ed1a759fd.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/0d6ecf115a0fefc045135d4dbfcfe920262c1b81.png b/installer/resources/core/RTGOperationsManual/_images/math/0d6ecf115a0fefc045135d4dbfcfe920262c1b81.png deleted file mode 100644 index 9ec83410f..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/0d6ecf115a0fefc045135d4dbfcfe920262c1b81.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/1dbc400fcc213305415872f9f625cd2828f97a00.png b/installer/resources/core/RTGOperationsManual/_images/math/1dbc400fcc213305415872f9f625cd2828f97a00.png deleted file mode 100644 index 185831550..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/1dbc400fcc213305415872f9f625cd2828f97a00.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/1dda4b44764a929f5d95a12343b22b3343e7993e.png b/installer/resources/core/RTGOperationsManual/_images/math/1dda4b44764a929f5d95a12343b22b3343e7993e.png new file mode 100644 index 000000000..d1fbf2d3a Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/1dda4b44764a929f5d95a12343b22b3343e7993e.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/23991ec1fa444bd42d05816c69d1ba02c12a264e.png b/installer/resources/core/RTGOperationsManual/_images/math/23991ec1fa444bd42d05816c69d1ba02c12a264e.png new file mode 100644 index 000000000..a080af3de Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/23991ec1fa444bd42d05816c69d1ba02c12a264e.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/2483bfc119f473931364741eadb1b413b84e3dff.png b/installer/resources/core/RTGOperationsManual/_images/math/2483bfc119f473931364741eadb1b413b84e3dff.png deleted file mode 100644 index 1e81dd7d4..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/2483bfc119f473931364741eadb1b413b84e3dff.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/24a4a3d3565eacdc678ca2e8cda9c27eac9abe6a.png b/installer/resources/core/RTGOperationsManual/_images/math/24a4a3d3565eacdc678ca2e8cda9c27eac9abe6a.png deleted file mode 100644 index 0c4c772b0..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/24a4a3d3565eacdc678ca2e8cda9c27eac9abe6a.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/276ab2f76e62085e8ec1a3fb0c5fff842c0b98e4.png b/installer/resources/core/RTGOperationsManual/_images/math/276ab2f76e62085e8ec1a3fb0c5fff842c0b98e4.png deleted file mode 100644 index 1884219c3..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/276ab2f76e62085e8ec1a3fb0c5fff842c0b98e4.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/28357bd43b973b6fe3b43cd8cb18a02b20d55648.png b/installer/resources/core/RTGOperationsManual/_images/math/28357bd43b973b6fe3b43cd8cb18a02b20d55648.png deleted file mode 100644 index 1c499f5f0..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/28357bd43b973b6fe3b43cd8cb18a02b20d55648.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/2895eb405a03db49e2217253743e51b83144c2ac.png b/installer/resources/core/RTGOperationsManual/_images/math/2895eb405a03db49e2217253743e51b83144c2ac.png new file mode 100644 index 000000000..9588b2f4b Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/2895eb405a03db49e2217253743e51b83144c2ac.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/2cfe4bba60af0396a6d88125e6619fa19cc59310.png b/installer/resources/core/RTGOperationsManual/_images/math/2cfe4bba60af0396a6d88125e6619fa19cc59310.png deleted file mode 100644 index b312397e8..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/2cfe4bba60af0396a6d88125e6619fa19cc59310.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/3a8b75e5acf08db588e4dceb7fb37bd6e45954e5.png b/installer/resources/core/RTGOperationsManual/_images/math/3a8b75e5acf08db588e4dceb7fb37bd6e45954e5.png deleted file mode 100644 index 2dfd0c40e..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/3a8b75e5acf08db588e4dceb7fb37bd6e45954e5.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/3d714ca7cb77ae0a59a33942b07a97523eb2ede6.png b/installer/resources/core/RTGOperationsManual/_images/math/3d714ca7cb77ae0a59a33942b07a97523eb2ede6.png deleted file mode 100644 index 5aa3f7673..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/3d714ca7cb77ae0a59a33942b07a97523eb2ede6.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/3e33daea0596958aba9bd9cf28865a39b7e48b25.png b/installer/resources/core/RTGOperationsManual/_images/math/3e33daea0596958aba9bd9cf28865a39b7e48b25.png new file mode 100644 index 000000000..d93f294f6 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/3e33daea0596958aba9bd9cf28865a39b7e48b25.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/4370f8a24787d16b6631cfde4d5e7bc06d8d42c7.png b/installer/resources/core/RTGOperationsManual/_images/math/4370f8a24787d16b6631cfde4d5e7bc06d8d42c7.png new file mode 100644 index 000000000..6323a0f1c Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/4370f8a24787d16b6631cfde4d5e7bc06d8d42c7.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/4b0ffe0e53244b2c1bff21382be9a5ab326276d1.png b/installer/resources/core/RTGOperationsManual/_images/math/4b0ffe0e53244b2c1bff21382be9a5ab326276d1.png deleted file mode 100644 index 65d24238d..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/4b0ffe0e53244b2c1bff21382be9a5ab326276d1.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/5163a30eacf7ec6ef0a4bacd6f37adc97e59a22e.png b/installer/resources/core/RTGOperationsManual/_images/math/5163a30eacf7ec6ef0a4bacd6f37adc97e59a22e.png deleted file mode 100644 index 9276590a4..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/5163a30eacf7ec6ef0a4bacd6f37adc97e59a22e.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/52ddc0cde6d632f631533173562fe3ca375b1f32.png b/installer/resources/core/RTGOperationsManual/_images/math/52ddc0cde6d632f631533173562fe3ca375b1f32.png new file mode 100644 index 000000000..9b4d0e8a5 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/52ddc0cde6d632f631533173562fe3ca375b1f32.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/567fdf012fd3643c1df136a2e28f66591b626323.png b/installer/resources/core/RTGOperationsManual/_images/math/567fdf012fd3643c1df136a2e28f66591b626323.png deleted file mode 100644 index 193982e4b..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/567fdf012fd3643c1df136a2e28f66591b626323.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/5698fa961e23bd31116fc14bcc700c3c82564201.png b/installer/resources/core/RTGOperationsManual/_images/math/5698fa961e23bd31116fc14bcc700c3c82564201.png deleted file mode 100644 index 10a378632..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/5698fa961e23bd31116fc14bcc700c3c82564201.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/57540cfddc027fe046444894db8bb84952eaff1f.png b/installer/resources/core/RTGOperationsManual/_images/math/57540cfddc027fe046444894db8bb84952eaff1f.png new file mode 100644 index 000000000..a0312b18c Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/57540cfddc027fe046444894db8bb84952eaff1f.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/593c511ee9aeb89e927882c5cb67418a46da3828.png b/installer/resources/core/RTGOperationsManual/_images/math/593c511ee9aeb89e927882c5cb67418a46da3828.png new file mode 100644 index 000000000..be84ca9ad Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/593c511ee9aeb89e927882c5cb67418a46da3828.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/5a939c5280da7202ca4531f175a7780ad5e1f80a.png b/installer/resources/core/RTGOperationsManual/_images/math/5a939c5280da7202ca4531f175a7780ad5e1f80a.png new file mode 100644 index 000000000..4ebda0d92 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/5a939c5280da7202ca4531f175a7780ad5e1f80a.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/5cef678b81febf5ec6b208c557e607eed45b9e2a.png b/installer/resources/core/RTGOperationsManual/_images/math/5cef678b81febf5ec6b208c557e607eed45b9e2a.png deleted file mode 100644 index 21ec2ead4..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/5cef678b81febf5ec6b208c557e607eed45b9e2a.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/60ec5a4e636f260cafc63c490e2da12d8e36b418.png b/installer/resources/core/RTGOperationsManual/_images/math/60ec5a4e636f260cafc63c490e2da12d8e36b418.png deleted file mode 100644 index 2007f22d1..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/60ec5a4e636f260cafc63c490e2da12d8e36b418.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/61e31c976978a6cea362a491cd9d463454c1e0fb.png b/installer/resources/core/RTGOperationsManual/_images/math/61e31c976978a6cea362a491cd9d463454c1e0fb.png deleted file mode 100644 index b0370162c..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/61e31c976978a6cea362a491cd9d463454c1e0fb.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/6596b3f1d72eeb3b72dd1cdaaae199a4a3b1a412.png b/installer/resources/core/RTGOperationsManual/_images/math/6596b3f1d72eeb3b72dd1cdaaae199a4a3b1a412.png new file mode 100644 index 000000000..b313b252b Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/6596b3f1d72eeb3b72dd1cdaaae199a4a3b1a412.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/66e94f41a0f1e5615bd662691764d652b37d7338.png b/installer/resources/core/RTGOperationsManual/_images/math/66e94f41a0f1e5615bd662691764d652b37d7338.png deleted file mode 100644 index 38b91cb9d..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/66e94f41a0f1e5615bd662691764d652b37d7338.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/67e012a427a90dc0c0f8a2d5939a95e5f6ffe591.png b/installer/resources/core/RTGOperationsManual/_images/math/67e012a427a90dc0c0f8a2d5939a95e5f6ffe591.png new file mode 100644 index 000000000..18bcc39a8 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/67e012a427a90dc0c0f8a2d5939a95e5f6ffe591.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/684381a21cd73ebbf43b63a087d3f7410ee99ce8.png b/installer/resources/core/RTGOperationsManual/_images/math/684381a21cd73ebbf43b63a087d3f7410ee99ce8.png deleted file mode 100644 index dcac5aa56..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/684381a21cd73ebbf43b63a087d3f7410ee99ce8.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/6c754ae3fc49dc56e236eb95ef00cfdcad3df594.png b/installer/resources/core/RTGOperationsManual/_images/math/6c754ae3fc49dc56e236eb95ef00cfdcad3df594.png new file mode 100644 index 000000000..8325634c6 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/6c754ae3fc49dc56e236eb95ef00cfdcad3df594.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/76f1d8ace30435987c01a00ca53a71cba1f40e6c.png b/installer/resources/core/RTGOperationsManual/_images/math/76f1d8ace30435987c01a00ca53a71cba1f40e6c.png deleted file mode 100644 index cfb47f4bc..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/76f1d8ace30435987c01a00ca53a71cba1f40e6c.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/888f7c323ac0341871e867220ae2d76467d74d6e.png b/installer/resources/core/RTGOperationsManual/_images/math/888f7c323ac0341871e867220ae2d76467d74d6e.png new file mode 100644 index 000000000..c91738acf Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/888f7c323ac0341871e867220ae2d76467d74d6e.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/92ddcd7319ecbea8436f1b18fbebf544a38e4c69.png b/installer/resources/core/RTGOperationsManual/_images/math/92ddcd7319ecbea8436f1b18fbebf544a38e4c69.png new file mode 100644 index 000000000..0e25e38e8 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/92ddcd7319ecbea8436f1b18fbebf544a38e4c69.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/9dcbbef8e0f76051d388013b90a95bec3069e484.png b/installer/resources/core/RTGOperationsManual/_images/math/9dcbbef8e0f76051d388013b90a95bec3069e484.png deleted file mode 100644 index 87f5e3167..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/9dcbbef8e0f76051d388013b90a95bec3069e484.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/9e32cdd0b4d023c3e9b3e724291a03bdbcbee572.png b/installer/resources/core/RTGOperationsManual/_images/math/9e32cdd0b4d023c3e9b3e724291a03bdbcbee572.png new file mode 100644 index 000000000..f95e01d61 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/9e32cdd0b4d023c3e9b3e724291a03bdbcbee572.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/a59f68a4202623bb859a7093f0316bf466e6f75d.png b/installer/resources/core/RTGOperationsManual/_images/math/a59f68a4202623bb859a7093f0316bf466e6f75d.png deleted file mode 100644 index 2047e4714..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/a59f68a4202623bb859a7093f0316bf466e6f75d.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/af517d52259b23914a79dc82c765d702ec5cf7b1.png b/installer/resources/core/RTGOperationsManual/_images/math/af517d52259b23914a79dc82c765d702ec5cf7b1.png new file mode 100644 index 000000000..a423e5012 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/af517d52259b23914a79dc82c765d702ec5cf7b1.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/b4e2012103f1c4a304de5f04d2c95b2fa7ddcd73.png b/installer/resources/core/RTGOperationsManual/_images/math/b4e2012103f1c4a304de5f04d2c95b2fa7ddcd73.png deleted file mode 100644 index 5de77dae4..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/b4e2012103f1c4a304de5f04d2c95b2fa7ddcd73.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/b6f66d1803a9dcb5f12f25c57d4e43fb6584ca7e.png b/installer/resources/core/RTGOperationsManual/_images/math/b6f66d1803a9dcb5f12f25c57d4e43fb6584ca7e.png new file mode 100644 index 000000000..f4e2d3ab4 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/b6f66d1803a9dcb5f12f25c57d4e43fb6584ca7e.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/b81c7a12342c0ee157b2c3f1bcfc4f91642187dc.png b/installer/resources/core/RTGOperationsManual/_images/math/b81c7a12342c0ee157b2c3f1bcfc4f91642187dc.png new file mode 100644 index 000000000..5c52c4169 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/b81c7a12342c0ee157b2c3f1bcfc4f91642187dc.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/b988975be41fd13b4d091c10202ba19374643586.png b/installer/resources/core/RTGOperationsManual/_images/math/b988975be41fd13b4d091c10202ba19374643586.png new file mode 100644 index 000000000..a10fe36f7 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/b988975be41fd13b4d091c10202ba19374643586.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/ba8123ebfe56a852560851932a86adaef704bbb7.png b/installer/resources/core/RTGOperationsManual/_images/math/ba8123ebfe56a852560851932a86adaef704bbb7.png deleted file mode 100644 index 7eefdd7c6..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/ba8123ebfe56a852560851932a86adaef704bbb7.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/c2aa3dff9bffb099e9dff196fd36aed56ec16baf.png b/installer/resources/core/RTGOperationsManual/_images/math/c2aa3dff9bffb099e9dff196fd36aed56ec16baf.png new file mode 100644 index 000000000..e1683da7b Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/c2aa3dff9bffb099e9dff196fd36aed56ec16baf.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/c61adab5a368b41156d78099e64eaef7d3a9fb30.png b/installer/resources/core/RTGOperationsManual/_images/math/c61adab5a368b41156d78099e64eaef7d3a9fb30.png new file mode 100644 index 000000000..8e415eee8 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/c61adab5a368b41156d78099e64eaef7d3a9fb30.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/cefc603e5658facb747581f9567192993f21c7ab.png b/installer/resources/core/RTGOperationsManual/_images/math/cefc603e5658facb747581f9567192993f21c7ab.png new file mode 100644 index 000000000..749d58820 Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/cefc603e5658facb747581f9567192993f21c7ab.png differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/d87c941fdcf46735e757ab196fe03da2ea08ec45.png b/installer/resources/core/RTGOperationsManual/_images/math/d87c941fdcf46735e757ab196fe03da2ea08ec45.png deleted file mode 100644 index f9a489b71..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/d87c941fdcf46735e757ab196fe03da2ea08ec45.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/e11f2701c4a39c7fe543a6c4150b421d50f1c159.png b/installer/resources/core/RTGOperationsManual/_images/math/e11f2701c4a39c7fe543a6c4150b421d50f1c159.png deleted file mode 100644 index 991b8ed27..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_images/math/e11f2701c4a39c7fe543a6c4150b421d50f1c159.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_images/math/f13fefe97363643ae6879e8f163616d0cf50ab3f.png b/installer/resources/core/RTGOperationsManual/_images/math/f13fefe97363643ae6879e8f163616d0cf50ab3f.png new file mode 100644 index 000000000..b5370a08a Binary files /dev/null and b/installer/resources/core/RTGOperationsManual/_images/math/f13fefe97363643ae6879e8f163616d0cf50ab3f.png differ diff --git a/installer/resources/core/RTGOperationsManual/_sources/appendix.rst.txt b/installer/resources/core/RTGOperationsManual/_sources/appendix.rst.txt index a9d2baa69..da3bf8eae 100644 --- a/installer/resources/core/RTGOperationsManual/_sources/appendix.rst.txt +++ b/installer/resources/core/RTGOperationsManual/_sources/appendix.rst.txt @@ -120,7 +120,8 @@ other contigs. It is specified with the following structure: either def -The *ploidy* field is one of ``diploid``, ``haploid``, ``polyploid`` or +The *ploidy* field is one of ``haploid``, ``diploid``, ``triploid``, +``tetraploid``, ``pentaploid``, ``hexaploid``, ``polyploid`` or ``none``. The *shape* field is one of ``circular`` or ``linear``. The specific chromosome settings lines are similar to the default @@ -350,7 +351,7 @@ Within the context of a ``--keep-expr`` or ``record`` function these variables will provide access to the String representation of the VCF column of the same name. -.. code-block:: text +.. code-block:: javascript CHROM; // "1" POS; // "11259340" @@ -363,7 +364,7 @@ ALT, FILTER Will retrieve an array of the values in the column. -.. code-block:: text +.. code-block:: javascript ALT; // ["C", "T"] FILTER; // ["PASS"] @@ -378,7 +379,7 @@ Missing fields will be represented by "``.``". Assigning to these properties will update the VCF record. This will be undefined for fields not declared in the header. -.. code-block:: text +.. code-block:: javascript INFO.DP; // "795" INFO.ABC; // "4,5" @@ -392,7 +393,7 @@ format fields for each sample. The string representation of values in the sample column are accessible as properties on the string matching the sample name named after the ``FORMAT`` field ``ID``. -.. code-block:: text +.. code-block:: javascript 'NA12877'.GT; // "1/2" 'NA12878'.GT; // "1/0" @@ -410,10 +411,10 @@ Most components of VCF records can be written or updated in a fairly natural manner by direct assignment in order to make modifications. For example: -.. code-block:: text +.. code-block:: javascript CHROM = "chr1"; // Will change the CHROM value - POS = 42; // Will change the POS value + POS = 42; // Will change the POS value ID = "rs23987382"; // Will change the ID value QUAL = "50"; // Will change the QUAL value FILTER = "FAIL"; // Will set the FILTER value @@ -429,12 +430,12 @@ and ``ALT``) are considered immutable and can not currently be altered. or tool. Depending on the new value assigned to ``CHROM`` it may also be necessary to modify the sequence dictionary in the VCF header to reflect the change (see :ref:`VCF header modification`). - + Direct assignment to ``ID`` and ``FILTER`` fields accept either a string containing semicolon separated values, or a list of values. For example: -.. code-block:: text +.. code-block:: javascript ID = 'rs23987382;COSM3805'; ID = ['rs23987382', 'COSM3805']; @@ -450,7 +451,7 @@ Adding a filter to existing filters is a common operation and can be accomplished by the above assignment methods, for example by adding a value to the existing list and then setting the result: -.. code-block:: text +.. code-block:: javascript var f = FILTER; f.push('BOING'); @@ -459,7 +460,7 @@ value to the existing list and then setting the result: However, since this is a little unwieldy, a convenience function called `add()` can be used (and may be chained): -.. code-block:: text +.. code-block:: javascript FILTER.add('BOING'); FILTER.add(['BOING', 'DOING'); @@ -474,41 +475,103 @@ Functions are provided that allow the addition of new ``FILTER``, recommended that the following functions only be used within the run-once portion of ``--javascript``. -ensureFormatHeader(FORMAT\_HEADER\_STRING) -`````````````````````````````````````````` +ensureFormatHeader({FORMAT\_HEADER\_STRING}) +```````````````````````````````````````````` Add a new ``FORMAT`` field to the VCF if it is not already present. This will add a ``FORMAT`` declaration line to the header and define the corresponding accessor methods for use in record processing. -.. code-block:: text +.. code-block:: javascript ensureFormatHeader('##FORMAT='); -ensureInfoHeader(INFO\_HEADER\_STRING) -`````````````````````````````````````` +ensureInfoHeader({INFO\_HEADER\_STRING}) +```````````````````````````````````````` Add a new ``INFO`` field to the VCF if it is not already present. This will add an ``INFO`` declaration line to the header and define the corresponding accessor methods for use in record processing. -.. code-block:: text +.. code-block:: javascript ensureInfoHeader('##INFO='); -ensureFilterHeader(FILTER\_HEADER\_STRING) -`````````````````````````````````````````` +ensureFilterHeader({FILTER\_HEADER\_STRING}) +```````````````````````````````````````````` Add a new ``FILTER`` field to the VCF header if it is not already present. This will add an ``FILTER`` declaration line to the header. -.. code-block:: text +.. code-block:: javascript ensureFilterHeader('##INFO='); + +Testing for overlap with genomic regions +~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ + +One common use case is to test whether any given VCF record overlaps or +is contained within a set of genomic regions. Regions may be loaded from +either an external BED file or VCF file in the run-once portion of the +JavaScript by either of the following: + +Regions.fromBed({FILENAME}) +``````````````````````````` + +Load the specified BED file into a `regions` object. For example: + +.. code-block:: javascript + + var myregions = Regions.fromBed('/path/to/regions.bed'); + +Regions.fromVcf({FILENAME}) +``````````````````````````` + +Load the specified VCF file into a `regions` object. For example: + +.. code-block:: javascript + + var myregions = Regions.fromVcf('/path/to/regions.vcf'); + + +Having loaded a set of genomic regions, this can be used to test for +region overlaps using the following methods: + +{REGIONS\_OBJECT}.overlaps({CHROM}, {START}, {END}) +``````````````````````````````````````````````````` + +Return true if the loaded regions overlap the specified interval. This +function is typically used within the ``record`` function to test the +coordinates of the current VCF record, e.g.: + +.. code-block:: javascript + + function record() { + if (myregions.overlaps(CHROM, POS, POS + REF.length)) { + // do something if the record overlaps any region + } + } + +{REGIONS\_OBJECT}.encloses({CHROM}, {START}, {END}) +``````````````````````````````````````````````````` + +Return true if the loaded regions entirely encloses the supplied +interval. This function is typically used within the ``record`` +function to test the coordinates of the current VCF record, e.g.: + +.. code-block:: javascript + + function record() { + if (myregions.encloses(CHROM, POS, POS + REF.length)) { + // do something if the record is fully enclosed by any region + } + } + + Additional information and functions ~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~ @@ -517,37 +580,37 @@ SAMPLES This variable contains an array of the sample names in the VCF header. -.. code-block:: text +.. code-block:: javascript SAMPLES; // ['NA12877', 'NA12878'] print({STRING}) ``````````````` -Writes the provided string to standard output. +Write the provided string to standard output. -.. code-block:: text +.. code-block:: javascript print('The samples are: ' + SAMPLES); error({STRING}) ``````````````` -Writes the provided string to standard error. +Write the provided string to standard error. -.. code-block:: text +.. code-block:: javascript error('The samples are: ' + SAMPLES); checkMinVersion(RTG_MINIMUM_VERSION) ```````````````````````````````````` -Checks the version of RTG that the script is running under, and exits +Check the version of RTG that the script is running under, and exits with an error message if the version of RTG does not meet the minimum required version. This is useful when distributing scripts that make use of features that are not present in earlier versions of RTG. -.. code-block:: text +.. code-block:: javascript checkMinVersion('3.9.2'); diff --git a/installer/resources/core/RTGOperationsManual/_static/ajax-loader.gif b/installer/resources/core/RTGOperationsManual/_static/ajax-loader.gif deleted file mode 100644 index 61faf8cab..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_static/ajax-loader.gif and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_static/basic.css b/installer/resources/core/RTGOperationsManual/_static/basic.css index 0807176ec..295d6dad8 100644 --- a/installer/resources/core/RTGOperationsManual/_static/basic.css +++ b/installer/resources/core/RTGOperationsManual/_static/basic.css @@ -4,7 +4,7 @@ * * Sphinx stylesheet -- basic theme. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -15,6 +15,12 @@ div.clearer { clear: both; } +div.section::after { + display: block; + content: ''; + clear: left; +} + /* -- relbar ---------------------------------------------------------------- */ div.related { @@ -49,7 +55,7 @@ div.sphinxsidebarwrapper { div.sphinxsidebar { float: left; - width: 230px; + width: 210px; margin-left: -100%; font-size: 90%; word-wrap: break-word; @@ -231,6 +237,16 @@ a.headerlink { visibility: hidden; } +a.brackets:before, +span.brackets > a:before{ + content: "["; +} + +a.brackets:after, +span.brackets > a:after { + content: "]"; +} + h1:hover > a.headerlink, h2:hover > a.headerlink, h3:hover > a.headerlink, @@ -279,6 +295,12 @@ img.align-center, .figure.align-center, object.align-center { margin-right: auto; } +img.align-default, .figure.align-default { + display: block; + margin-left: auto; + margin-right: auto; +} + .align-left { text-align: left; } @@ -287,6 +309,10 @@ img.align-center, .figure.align-center, object.align-center { text-align: center; } +.align-default { + text-align: center; +} + .align-right { text-align: right; } @@ -296,21 +322,27 @@ img.align-center, .figure.align-center, object.align-center { div.sidebar { margin: 0 0 0.5em 1em; border: 1px solid #ddb; - padding: 7px 7px 0 7px; + padding: 7px; background-color: #ffe; width: 40%; float: right; + clear: right; + overflow-x: auto; } p.sidebar-title { font-weight: bold; } +div.admonition, div.topic, blockquote { + clear: left; +} + /* -- topics ---------------------------------------------------------------- */ div.topic { border: 1px solid #ccc; - padding: 7px 7px 0 7px; + padding: 7px; margin: 10px 0 10px 0; } @@ -332,10 +364,6 @@ div.admonition dt { font-weight: bold; } -div.admonition dl { - margin-bottom: 0; -} - p.admonition-title { margin: 0px 10px 5px 0px; font-weight: bold; @@ -346,9 +374,28 @@ div.body p.centered { margin-top: 25px; } +/* -- content of sidebars/topics/admonitions -------------------------------- */ + +div.sidebar > :last-child, +div.topic > :last-child, +div.admonition > :last-child { + margin-bottom: 0; +} + +div.sidebar::after, +div.topic::after, +div.admonition::after, +blockquote::after { + display: block; + content: ''; + clear: both; +} + /* -- tables ---------------------------------------------------------------- */ table.docutils { + margin-top: 10px; + margin-bottom: 10px; border: 0; border-collapse: collapse; } @@ -358,6 +405,11 @@ table.align-center { margin-right: auto; } +table.align-default { + margin-left: auto; + margin-right: auto; +} + table caption span.caption-number { font-style: italic; } @@ -391,6 +443,16 @@ table.citation td { border-bottom: none; } +th > :first-child, +td > :first-child { + margin-top: 0px; +} + +th > :last-child, +td > :last-child { + margin-bottom: 0px; +} + /* -- figures --------------------------------------------------------------- */ div.figure { @@ -433,6 +495,10 @@ table.field-list td, table.field-list th { /* -- hlist styles ---------------------------------------------------------- */ +table.hlist { + margin: 1em 0; +} + table.hlist td { vertical-align: top; } @@ -460,11 +526,78 @@ ol.upperroman { list-style: upper-roman; } +:not(li) > ol > li:first-child > :first-child, +:not(li) > ul > li:first-child > :first-child { + margin-top: 0px; +} + +:not(li) > ol > li:last-child > :last-child, +:not(li) > ul > li:last-child > :last-child { + margin-bottom: 0px; +} + +ol.simple ol p, +ol.simple ul p, +ul.simple ol p, +ul.simple ul p { + margin-top: 0; +} + +ol.simple > li:not(:first-child) > p, +ul.simple > li:not(:first-child) > p { + margin-top: 0; +} + +ol.simple p, +ul.simple p { + margin-bottom: 0; +} + +dl.footnote > dt, +dl.citation > dt { + float: left; + margin-right: 0.5em; +} + +dl.footnote > dd, +dl.citation > dd { + margin-bottom: 0em; +} + +dl.footnote > dd:after, +dl.citation > dd:after { + content: ""; + clear: both; +} + +dl.field-list { + display: grid; + grid-template-columns: fit-content(30%) auto; +} + +dl.field-list > dt { + font-weight: bold; + word-break: break-word; + padding-left: 0.5em; + padding-right: 5px; +} + +dl.field-list > dt:after { + content: ":"; +} + +dl.field-list > dd { + padding-left: 0.5em; + margin-top: 0em; + margin-left: 0em; + margin-bottom: 0em; +} + dl { margin-bottom: 15px; } -dd p { +dd > :first-child { margin-top: 0px; } @@ -478,6 +611,11 @@ dd { margin-left: 30px; } +dl > dd:last-child, +dl > dd:last-child > :last-child { + margin-bottom: 0; +} + dt:target, span.highlighted { background-color: #fbe54e; } @@ -537,6 +675,12 @@ dl.glossary dt { font-style: oblique; } +.classifier:before { + font-style: normal; + margin: 0.5em; + content: ":"; +} + abbr, acronym { border-bottom: dotted 1px; cursor: help; @@ -549,6 +693,10 @@ pre { overflow-y: hidden; /* fixes display issues on Chrome browsers */ } +pre, div[class|="highlight"] { + clear: both; +} + span.pre { -moz-hyphens: none; -ms-hyphens: none; @@ -556,22 +704,57 @@ span.pre { hyphens: none; } +div[class^="highlight-"] { + margin: 1em 0; +} + td.linenos pre { - padding: 5px 0px; border: 0; background-color: transparent; color: #aaa; } table.highlighttable { - margin-left: 0.5em; + display: block; +} + +table.highlighttable tbody { + display: block; +} + +table.highlighttable tr { + display: flex; } table.highlighttable td { - padding: 0 0.5em 0 0.5em; + margin: 0; + padding: 0; +} + +table.highlighttable td.linenos { + padding-right: 0.5em; +} + +table.highlighttable td.code { + flex: 1; + overflow: hidden; +} + +.highlight .hll { + display: block; +} + +div.highlight pre, +table.highlighttable pre { + margin: 0; +} + +div.code-block-caption + div { + margin-top: 0; } div.code-block-caption { + margin-top: 1em; padding: 2px 5px; font-size: small; } @@ -580,8 +763,9 @@ div.code-block-caption code { background-color: transparent; } -div.code-block-caption + div > div.highlight > pre { - margin-top: 0; +table.highlighttable td.linenos, +div.doctest > div.highlight span.gp { /* gp: Generic.Prompt */ + user-select: none; } div.code-block-caption span.caption-number { @@ -593,11 +777,7 @@ div.code-block-caption span.caption-text { } div.literal-block-wrapper { - padding: 1em 1em 0; -} - -div.literal-block-wrapper div.highlight { - margin: 0; + margin: 1em 0; } code.descname { @@ -648,8 +828,7 @@ span.eqno { } span.eqno a.headerlink { - position: relative; - left: 0px; + position: absolute; z-index: 1; } diff --git a/installer/resources/core/RTGOperationsManual/_static/bizstyle.js b/installer/resources/core/RTGOperationsManual/_static/bizstyle.js index a304904b7..672c96079 100644 --- a/installer/resources/core/RTGOperationsManual/_static/bizstyle.js +++ b/installer/resources/core/RTGOperationsManual/_static/bizstyle.js @@ -36,6 +36,6 @@ $(window).resize(function(){ $("li.nav-item-0 a").text("Top"); } else { - $("li.nav-item-0 a").text("RTG Core Operations Manual v3.11"); + $("li.nav-item-0 a").text("RTG Core Operations Manual v3.12"); } }); \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/_static/comment-bright.png b/installer/resources/core/RTGOperationsManual/_static/comment-bright.png deleted file mode 100644 index 15e27edb1..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_static/comment-bright.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_static/comment-close.png b/installer/resources/core/RTGOperationsManual/_static/comment-close.png deleted file mode 100644 index 4d91bcf57..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_static/comment-close.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_static/comment.png b/installer/resources/core/RTGOperationsManual/_static/comment.png deleted file mode 100644 index dfbc0cbd5..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_static/comment.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_static/doctools.js b/installer/resources/core/RTGOperationsManual/_static/doctools.js index 344db17dd..daccd209d 100644 --- a/installer/resources/core/RTGOperationsManual/_static/doctools.js +++ b/installer/resources/core/RTGOperationsManual/_static/doctools.js @@ -4,7 +4,7 @@ * * Sphinx JavaScript utilities for all documentation. * - * :copyright: Copyright 2007-2019 by the Sphinx team, see AUTHORS. + * :copyright: Copyright 2007-2020 by the Sphinx team, see AUTHORS. * :license: BSD, see LICENSE for details. * */ @@ -87,14 +87,13 @@ jQuery.fn.highlightText = function(text, className) { node.nextSibling)); node.nodeValue = val.substr(0, pos); if (isInSVG) { - var bbox = span.getBBox(); var rect = document.createElementNS("http://www.w3.org/2000/svg", "rect"); - rect.x.baseVal.value = bbox.x; + var bbox = node.parentElement.getBBox(); + rect.x.baseVal.value = bbox.x; rect.y.baseVal.value = bbox.y; rect.width.baseVal.value = bbox.width; rect.height.baseVal.value = bbox.height; rect.setAttribute('class', className); - var parentOfText = node.parentNode.parentNode; addItems.push({ "parent": node.parentNode, "target": rect}); @@ -284,10 +283,11 @@ var Documentation = { }, initOnKeyListeners: function() { - $(document).keyup(function(event) { + $(document).keydown(function(event) { var activeElementType = document.activeElement.tagName; // don't navigate when in search box or textarea - if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT') { + if (activeElementType !== 'TEXTAREA' && activeElementType !== 'INPUT' && activeElementType !== 'SELECT' + && !event.altKey && !event.ctrlKey && !event.metaKey && !event.shiftKey) { switch (event.keyCode) { case 37: // left var prevHref = $('link[rel="prev"]').prop('href'); diff --git a/installer/resources/core/RTGOperationsManual/_static/documentation_options.js b/installer/resources/core/RTGOperationsManual/_static/documentation_options.js index 53ee09118..6624cfe46 100644 --- a/installer/resources/core/RTGOperationsManual/_static/documentation_options.js +++ b/installer/resources/core/RTGOperationsManual/_static/documentation_options.js @@ -1,10 +1,12 @@ var DOCUMENTATION_OPTIONS = { URL_ROOT: document.getElementById("documentation_options").getAttribute('data-url_root'), - VERSION: '3.11', + VERSION: '3.12', LANGUAGE: 'None', COLLAPSE_INDEX: false, + BUILDER: 'html', FILE_SUFFIX: '.html', + LINK_SUFFIX: '.html', HAS_SOURCE: true, SOURCELINK_SUFFIX: '.txt', - NAVIGATION_WITH_KEYS: false, + NAVIGATION_WITH_KEYS: false }; \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/_static/down-pressed.png b/installer/resources/core/RTGOperationsManual/_static/down-pressed.png deleted file mode 100644 index 5756c8cad..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_static/down-pressed.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_static/down.png b/installer/resources/core/RTGOperationsManual/_static/down.png deleted file mode 100644 index 1b3bdad2c..000000000 Binary files a/installer/resources/core/RTGOperationsManual/_static/down.png and /dev/null differ diff --git a/installer/resources/core/RTGOperationsManual/_static/jquery-3.2.1.js b/installer/resources/core/RTGOperationsManual/_static/jquery-3.5.1.js similarity index 81% rename from installer/resources/core/RTGOperationsManual/_static/jquery-3.2.1.js rename to installer/resources/core/RTGOperationsManual/_static/jquery-3.5.1.js index d2d8ca479..50937333b 100644 --- a/installer/resources/core/RTGOperationsManual/_static/jquery-3.2.1.js +++ b/installer/resources/core/RTGOperationsManual/_static/jquery-3.5.1.js @@ -1,5 +1,5 @@ /*! - * jQuery JavaScript Library v3.2.1 + * jQuery JavaScript Library v3.5.1 * https://jquery.com/ * * Includes Sizzle.js @@ -9,7 +9,7 @@ * Released under the MIT license * https://jquery.org/license * - * Date: 2017-03-20T18:59Z + * Date: 2020-05-04T22:49Z */ ( function( global, factory ) { @@ -47,13 +47,16 @@ var arr = []; -var document = window.document; - var getProto = Object.getPrototypeOf; var slice = arr.slice; -var concat = arr.concat; +var flat = arr.flat ? function( array ) { + return arr.flat.call( array ); +} : function( array ) { + return arr.concat.apply( [], array ); +}; + var push = arr.push; @@ -71,16 +74,72 @@ var ObjectFunctionString = fnToString.call( Object ); var support = {}; +var isFunction = function isFunction( obj ) { + + // Support: Chrome <=57, Firefox <=52 + // In some browsers, typeof returns "function" for HTML elements + // (i.e., `typeof document.createElement( "object" ) === "function"`). + // We don't want to classify *any* DOM node as a function. + return typeof obj === "function" && typeof obj.nodeType !== "number"; + }; + + +var isWindow = function isWindow( obj ) { + return obj != null && obj === obj.window; + }; + + +var document = window.document; - function DOMEval( code, doc ) { + + var preservedScriptAttributes = { + type: true, + src: true, + nonce: true, + noModule: true + }; + + function DOMEval( code, node, doc ) { doc = doc || document; - var script = doc.createElement( "script" ); + var i, val, + script = doc.createElement( "script" ); script.text = code; + if ( node ) { + for ( i in preservedScriptAttributes ) { + + // Support: Firefox 64+, Edge 18+ + // Some browsers don't support the "nonce" property on scripts. + // On the other hand, just using `getAttribute` is not enough as + // the `nonce` attribute is reset to an empty string whenever it + // becomes browsing-context connected. + // See https://github.com/whatwg/html/issues/2369 + // See https://html.spec.whatwg.org/#nonce-attributes + // The `node.getAttribute` check was added for the sake of + // `jQuery.globalEval` so that it can fake a nonce-containing node + // via an object. + val = node[ i ] || node.getAttribute && node.getAttribute( i ); + if ( val ) { + script.setAttribute( i, val ); + } + } + } doc.head.appendChild( script ).parentNode.removeChild( script ); } + + +function toType( obj ) { + if ( obj == null ) { + return obj + ""; + } + + // Support: Android <=2.3 only (functionish RegExp) + return typeof obj === "object" || typeof obj === "function" ? + class2type[ toString.call( obj ) ] || "object" : + typeof obj; +} /* global Symbol */ // Defining this global in .eslintrc.json would create a danger of using the global // unguarded in another place, it seems safer to define global only for this module @@ -88,7 +147,7 @@ var support = {}; var - version = "3.2.1", + version = "3.5.1", // Define a local copy of jQuery jQuery = function( selector, context ) { @@ -96,19 +155,6 @@ var // The jQuery object is actually just the init constructor 'enhanced' // Need init if jQuery is called (just allow error to be thrown if not included) return new jQuery.fn.init( selector, context ); - }, - - // Support: Android <=4.0 only - // Make sure we trim BOM and NBSP - rtrim = /^[\s\uFEFF\xA0]+|[\s\uFEFF\xA0]+$/g, - - // Matches dashed string for camelizing - rmsPrefix = /^-ms-/, - rdashAlpha = /-([a-z])/g, - - // Used by jQuery.camelCase as callback to replace() - fcamelCase = function( all, letter ) { - return letter.toUpperCase(); }; jQuery.fn = jQuery.prototype = { @@ -175,6 +221,18 @@ jQuery.fn = jQuery.prototype = { return this.eq( -1 ); }, + even: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return ( i + 1 ) % 2; + } ) ); + }, + + odd: function() { + return this.pushStack( jQuery.grep( this, function( _elem, i ) { + return i % 2; + } ) ); + }, + eq: function( i ) { var len = this.length, j = +i + ( i < 0 ? len : 0 ); @@ -209,7 +267,7 @@ jQuery.extend = jQuery.fn.extend = function() { } // Handle case when target is a string or something (possible in deep copy) - if ( typeof target !== "object" && !jQuery.isFunction( target ) ) { + if ( typeof target !== "object" && !isFunction( target ) ) { target = {}; } @@ -226,25 +284,28 @@ jQuery.extend = jQuery.fn.extend = function() { // Extend the base object for ( name in options ) { - src = target[ name ]; copy = options[ name ]; + // Prevent Object.prototype pollution // Prevent never-ending loop - if ( target === copy ) { + if ( name === "__proto__" || target === copy ) { continue; } // Recurse if we're merging plain objects or arrays if ( deep && copy && ( jQuery.isPlainObject( copy ) || ( copyIsArray = Array.isArray( copy ) ) ) ) { + src = target[ name ]; - if ( copyIsArray ) { - copyIsArray = false; - clone = src && Array.isArray( src ) ? src : []; - + // Ensure proper type for the source value + if ( copyIsArray && !Array.isArray( src ) ) { + clone = []; + } else if ( !copyIsArray && !jQuery.isPlainObject( src ) ) { + clone = {}; } else { - clone = src && jQuery.isPlainObject( src ) ? src : {}; + clone = src; } + copyIsArray = false; // Never move original objects, clone them target[ name ] = jQuery.extend( deep, clone, copy ); @@ -275,28 +336,6 @@ jQuery.extend( { noop: function() {}, - isFunction: function( obj ) { - return jQuery.type( obj ) === "function"; - }, - - isWindow: function( obj ) { - return obj != null && obj === obj.window; - }, - - isNumeric: function( obj ) { - - // As of jQuery 3.0, isNumeric is limited to - // strings and numbers (primitives or objects) - // that can be coerced to finite numbers (gh-2662) - var type = jQuery.type( obj ); - return ( type === "number" || type === "string" ) && - - // parseFloat NaNs numeric-cast false positives ("") - // ...but misinterprets leading-number strings, particularly hex literals ("0x...") - // subtraction forces infinities to NaN - !isNaN( obj - parseFloat( obj ) ); - }, - isPlainObject: function( obj ) { var proto, Ctor; @@ -319,9 +358,6 @@ jQuery.extend( { }, isEmptyObject: function( obj ) { - - /* eslint-disable no-unused-vars */ - // See https://github.com/eslint/eslint/issues/6125 var name; for ( name in obj ) { @@ -330,27 +366,10 @@ jQuery.extend( { return true; }, - type: function( obj ) { - if ( obj == null ) { - return obj + ""; - } - - // Support: Android <=2.3 only (functionish RegExp) - return typeof obj === "object" || typeof obj === "function" ? - class2type[ toString.call( obj ) ] || "object" : - typeof obj; - }, - - // Evaluates a script in a global context - globalEval: function( code ) { - DOMEval( code ); - }, - - // Convert dashed to camelCase; used by the css and data modules - // Support: IE <=9 - 11, Edge 12 - 13 - // Microsoft forgot to hump their vendor prefix (#9572) - camelCase: function( string ) { - return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); + // Evaluates a script in a provided context; falls back to the global one + // if not specified. + globalEval: function( code, options, doc ) { + DOMEval( code, { nonce: options && options.nonce }, doc ); }, each: function( obj, callback ) { @@ -374,13 +393,6 @@ jQuery.extend( { return obj; }, - // Support: Android <=4.0 only - trim: function( text ) { - return text == null ? - "" : - ( text + "" ).replace( rtrim, "" ); - }, - // results is for internal usage only makeArray: function( arr, results ) { var ret = results || []; @@ -467,43 +479,12 @@ jQuery.extend( { } // Flatten any nested arrays - return concat.apply( [], ret ); + return flat( ret ); }, // A global GUID counter for objects guid: 1, - // Bind a function to a context, optionally partially applying any - // arguments. - proxy: function( fn, context ) { - var tmp, args, proxy; - - if ( typeof context === "string" ) { - tmp = fn[ context ]; - context = fn; - fn = tmp; - } - - // Quick check to determine if target is callable, in the spec - // this throws a TypeError, but we will just return undefined. - if ( !jQuery.isFunction( fn ) ) { - return undefined; - } - - // Simulated bind - args = slice.call( arguments, 2 ); - proxy = function() { - return fn.apply( context || this, args.concat( slice.call( arguments ) ) ); - }; - - // Set the guid of unique handler to the same of original handler, so it can be removed - proxy.guid = fn.guid = fn.guid || jQuery.guid++; - - return proxy; - }, - - now: Date.now, - // jQuery.support is not used in Core but other projects attach their // properties to it so it needs to exist. support: support @@ -515,7 +496,7 @@ if ( typeof Symbol === "function" ) { // Populate the class2type map jQuery.each( "Boolean Number String Function Array Date RegExp Object Error Symbol".split( " " ), -function( i, name ) { +function( _i, name ) { class2type[ "[object " + name + "]" ] = name.toLowerCase(); } ); @@ -526,9 +507,9 @@ function isArrayLike( obj ) { // hasOwn isn't used here due to false negatives // regarding Nodelist length in IE var length = !!obj && "length" in obj && obj.length, - type = jQuery.type( obj ); + type = toType( obj ); - if ( type === "function" || jQuery.isWindow( obj ) ) { + if ( isFunction( obj ) || isWindow( obj ) ) { return false; } @@ -537,17 +518,16 @@ function isArrayLike( obj ) { } var Sizzle = /*! - * Sizzle CSS Selector Engine v2.3.3 + * Sizzle CSS Selector Engine v2.3.5 * https://sizzlejs.com/ * - * Copyright jQuery Foundation and other contributors + * Copyright JS Foundation and other contributors * Released under the MIT license - * http://jquery.org/license + * https://js.foundation/ * - * Date: 2016-08-08 + * Date: 2020-03-14 */ -(function( window ) { - +( function( window ) { var i, support, Expr, @@ -578,6 +558,7 @@ var i, classCache = createCache(), tokenCache = createCache(), compilerCache = createCache(), + nonnativeSelectorCache = createCache(), sortOrder = function( a, b ) { if ( a === b ) { hasDuplicate = true; @@ -586,61 +567,71 @@ var i, }, // Instance methods - hasOwn = ({}).hasOwnProperty, + hasOwn = ( {} ).hasOwnProperty, arr = [], pop = arr.pop, - push_native = arr.push, + pushNative = arr.push, push = arr.push, slice = arr.slice, + // Use a stripped-down indexOf as it's faster than native // https://jsperf.com/thor-indexof-vs-for/5 indexOf = function( list, elem ) { var i = 0, len = list.length; for ( ; i < len; i++ ) { - if ( list[i] === elem ) { + if ( list[ i ] === elem ) { return i; } } return -1; }, - booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|ismap|loop|multiple|open|readonly|required|scoped", + booleans = "checked|selected|async|autofocus|autoplay|controls|defer|disabled|hidden|" + + "ismap|loop|multiple|open|readonly|required|scoped", // Regular expressions // http://www.w3.org/TR/css3-selectors/#whitespace whitespace = "[\\x20\\t\\r\\n\\f]", - // http://www.w3.org/TR/CSS21/syndata.html#value-def-identifier - identifier = "(?:\\\\.|[\\w-]|[^\0-\\xa0])+", + // https://www.w3.org/TR/css-syntax-3/#ident-token-diagram + identifier = "(?:\\\\[\\da-fA-F]{1,6}" + whitespace + + "?|\\\\[^\\r\\n\\f]|[\\w-]|[^\0-\\x7f])+", // Attribute selectors: http://www.w3.org/TR/selectors/#attribute-selectors attributes = "\\[" + whitespace + "*(" + identifier + ")(?:" + whitespace + + // Operator (capture 2) "*([*^$|!~]?=)" + whitespace + - // "Attribute values must be CSS identifiers [capture 5] or strings [capture 3 or capture 4]" - "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + whitespace + - "*\\]", + + // "Attribute values must be CSS identifiers [capture 5] + // or strings [capture 3 or capture 4]" + "*(?:'((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\"|(" + identifier + "))|)" + + whitespace + "*\\]", pseudos = ":(" + identifier + ")(?:\\((" + + // To reduce the number of selectors needing tokenize in the preFilter, prefer arguments: // 1. quoted (capture 3; capture 4 or capture 5) "('((?:\\\\.|[^\\\\'])*)'|\"((?:\\\\.|[^\\\\\"])*)\")|" + + // 2. simple (capture 6) "((?:\\\\.|[^\\\\()[\\]]|" + attributes + ")*)|" + + // 3. anything else (capture 2) ".*" + ")\\)|)", // Leading and non-escaped trailing whitespace, capturing some non-whitespace characters preceding the latter rwhitespace = new RegExp( whitespace + "+", "g" ), - rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + whitespace + "+$", "g" ), + rtrim = new RegExp( "^" + whitespace + "+|((?:^|[^\\\\])(?:\\\\.)*)" + + whitespace + "+$", "g" ), rcomma = new RegExp( "^" + whitespace + "*," + whitespace + "*" ), - rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + "*" ), - - rattributeQuotes = new RegExp( "=" + whitespace + "*([^\\]'\"]*?)" + whitespace + "*\\]", "g" ), + rcombinators = new RegExp( "^" + whitespace + "*([>+~]|" + whitespace + ")" + whitespace + + "*" ), + rdescend = new RegExp( whitespace + "|>" ), rpseudo = new RegExp( pseudos ), ridentifier = new RegExp( "^" + identifier + "$" ), @@ -651,16 +642,19 @@ var i, "TAG": new RegExp( "^(" + identifier + "|[*])" ), "ATTR": new RegExp( "^" + attributes ), "PSEUDO": new RegExp( "^" + pseudos ), - "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + whitespace + - "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + whitespace + - "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), + "CHILD": new RegExp( "^:(only|first|last|nth|nth-last)-(child|of-type)(?:\\(" + + whitespace + "*(even|odd|(([+-]|)(\\d*)n|)" + whitespace + "*(?:([+-]|)" + + whitespace + "*(\\d+)|))" + whitespace + "*\\)|)", "i" ), "bool": new RegExp( "^(?:" + booleans + ")$", "i" ), + // For use in libraries implementing .is() // We use this for POS matching in `select` - "needsContext": new RegExp( "^" + whitespace + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + - whitespace + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) + "needsContext": new RegExp( "^" + whitespace + + "*[>+~]|:(even|odd|eq|gt|lt|nth|first|last)(?:\\(" + whitespace + + "*((?:-\\d)?\\d*)" + whitespace + "*\\)|)(?=[^-]|$)", "i" ) }, + rhtml = /HTML$/i, rinputs = /^(?:input|select|textarea|button)$/i, rheader = /^h\d$/i, @@ -673,18 +667,21 @@ var i, // CSS escapes // http://www.w3.org/TR/CSS21/syndata.html#escaped-characters - runescape = new RegExp( "\\\\([\\da-f]{1,6}" + whitespace + "?|(" + whitespace + ")|.)", "ig" ), - funescape = function( _, escaped, escapedWhitespace ) { - var high = "0x" + escaped - 0x10000; - // NaN means non-codepoint - // Support: Firefox<24 - // Workaround erroneous numeric interpretation of +"0x" - return high !== high || escapedWhitespace ? - escaped : + runescape = new RegExp( "\\\\[\\da-fA-F]{1,6}" + whitespace + "?|\\\\([^\\r\\n\\f])", "g" ), + funescape = function( escape, nonHex ) { + var high = "0x" + escape.slice( 1 ) - 0x10000; + + return nonHex ? + + // Strip the backslash prefix from a non-hex escape sequence + nonHex : + + // Replace a hexadecimal escape sequence with the encoded Unicode code point + // Support: IE <=11+ + // For values outside the Basic Multilingual Plane (BMP), manually construct a + // surrogate pair high < 0 ? - // BMP codepoint String.fromCharCode( high + 0x10000 ) : - // Supplemental Plane codepoint (surrogate pair) String.fromCharCode( high >> 10 | 0xD800, high & 0x3FF | 0xDC00 ); }, @@ -700,7 +697,8 @@ var i, } // Control characters and (dependent upon position) numbers get escaped as code points - return ch.slice( 0, -1 ) + "\\" + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; + return ch.slice( 0, -1 ) + "\\" + + ch.charCodeAt( ch.length - 1 ).toString( 16 ) + " "; } // Other potentially-special ASCII characters get backslash-escaped @@ -715,9 +713,9 @@ var i, setDocument(); }, - disabledAncestor = addCombinator( + inDisabledFieldset = addCombinator( function( elem ) { - return elem.disabled === true && ("form" in elem || "label" in elem); + return elem.disabled === true && elem.nodeName.toLowerCase() === "fieldset"; }, { dir: "parentNode", next: "legend" } ); @@ -725,18 +723,20 @@ var i, // Optimize for push.apply( _, NodeList ) try { push.apply( - (arr = slice.call( preferredDoc.childNodes )), + ( arr = slice.call( preferredDoc.childNodes ) ), preferredDoc.childNodes ); + // Support: Android<4.0 // Detect silently failing push.apply + // eslint-disable-next-line no-unused-expressions arr[ preferredDoc.childNodes.length ].nodeType; } catch ( e ) { push = { apply: arr.length ? // Leverage slice if possible function( target, els ) { - push_native.apply( target, slice.call(els) ); + pushNative.apply( target, slice.call( els ) ); } : // Support: IE<9 @@ -744,8 +744,9 @@ try { function( target, els ) { var j = target.length, i = 0; + // Can't trust NodeList.length - while ( (target[j++] = els[i++]) ) {} + while ( ( target[ j++ ] = els[ i++ ] ) ) {} target.length = j - 1; } }; @@ -769,24 +770,21 @@ function Sizzle( selector, context, results, seed ) { // Try to shortcut find operations (as opposed to filters) in HTML documents if ( !seed ) { - - if ( ( context ? context.ownerDocument || context : preferredDoc ) !== document ) { - setDocument( context ); - } + setDocument( context ); context = context || document; if ( documentIsHTML ) { // If the selector is sufficiently simple, try using a "get*By*" DOM method // (excepting DocumentFragment context, where the methods don't exist) - if ( nodeType !== 11 && (match = rquickExpr.exec( selector )) ) { + if ( nodeType !== 11 && ( match = rquickExpr.exec( selector ) ) ) { // ID selector - if ( (m = match[1]) ) { + if ( ( m = match[ 1 ] ) ) { // Document context if ( nodeType === 9 ) { - if ( (elem = context.getElementById( m )) ) { + if ( ( elem = context.getElementById( m ) ) ) { // Support: IE, Opera, Webkit // TODO: identify versions @@ -805,7 +803,7 @@ function Sizzle( selector, context, results, seed ) { // Support: IE, Opera, Webkit // TODO: identify versions // getElementById can match elements by name instead of ID - if ( newContext && (elem = newContext.getElementById( m )) && + if ( newContext && ( elem = newContext.getElementById( m ) ) && contains( context, elem ) && elem.id === m ) { @@ -815,12 +813,12 @@ function Sizzle( selector, context, results, seed ) { } // Type selector - } else if ( match[2] ) { + } else if ( match[ 2 ] ) { push.apply( results, context.getElementsByTagName( selector ) ); return results; // Class selector - } else if ( (m = match[3]) && support.getElementsByClassName && + } else if ( ( m = match[ 3 ] ) && support.getElementsByClassName && context.getElementsByClassName ) { push.apply( results, context.getElementsByClassName( m ) ); @@ -830,50 +828,62 @@ function Sizzle( selector, context, results, seed ) { // Take advantage of querySelectorAll if ( support.qsa && - !compilerCache[ selector + " " ] && - (!rbuggyQSA || !rbuggyQSA.test( selector )) ) { - - if ( nodeType !== 1 ) { - newContext = context; - newSelector = selector; + !nonnativeSelectorCache[ selector + " " ] && + ( !rbuggyQSA || !rbuggyQSA.test( selector ) ) && - // qSA looks outside Element context, which is not what we want - // Thanks to Andrew Dupont for this workaround technique - // Support: IE <=8 + // Support: IE 8 only // Exclude object elements - } else if ( context.nodeName.toLowerCase() !== "object" ) { + ( nodeType !== 1 || context.nodeName.toLowerCase() !== "object" ) ) { - // Capture the context ID, setting it first if necessary - if ( (nid = context.getAttribute( "id" )) ) { - nid = nid.replace( rcssescape, fcssescape ); - } else { - context.setAttribute( "id", (nid = expando) ); + newSelector = selector; + newContext = context; + + // qSA considers elements outside a scoping root when evaluating child or + // descendant combinators, which is not what we want. + // In such cases, we work around the behavior by prefixing every selector in the + // list with an ID selector referencing the scope context. + // The technique has to be used as well when a leading combinator is used + // as such selectors are not recognized by querySelectorAll. + // Thanks to Andrew Dupont for this technique. + if ( nodeType === 1 && + ( rdescend.test( selector ) || rcombinators.test( selector ) ) ) { + + // Expand context for sibling selectors + newContext = rsibling.test( selector ) && testContext( context.parentNode ) || + context; + + // We can use :scope instead of the ID hack if the browser + // supports it & if we're not changing the context. + if ( newContext !== context || !support.scope ) { + + // Capture the context ID, setting it first if necessary + if ( ( nid = context.getAttribute( "id" ) ) ) { + nid = nid.replace( rcssescape, fcssescape ); + } else { + context.setAttribute( "id", ( nid = expando ) ); + } } // Prefix every selector in the list groups = tokenize( selector ); i = groups.length; while ( i-- ) { - groups[i] = "#" + nid + " " + toSelector( groups[i] ); + groups[ i ] = ( nid ? "#" + nid : ":scope" ) + " " + + toSelector( groups[ i ] ); } newSelector = groups.join( "," ); - - // Expand context for sibling selectors - newContext = rsibling.test( selector ) && testContext( context.parentNode ) || - context; } - if ( newSelector ) { - try { - push.apply( results, - newContext.querySelectorAll( newSelector ) - ); - return results; - } catch ( qsaError ) { - } finally { - if ( nid === expando ) { - context.removeAttribute( "id" ); - } + try { + push.apply( results, + newContext.querySelectorAll( newSelector ) + ); + return results; + } catch ( qsaError ) { + nonnativeSelectorCache( selector, true ); + } finally { + if ( nid === expando ) { + context.removeAttribute( "id" ); } } } @@ -894,12 +904,14 @@ function createCache() { var keys = []; function cache( key, value ) { + // Use (key + " ") to avoid collision with native prototype properties (see Issue #157) if ( keys.push( key + " " ) > Expr.cacheLength ) { + // Only keep the most recent entries delete cache[ keys.shift() ]; } - return (cache[ key + " " ] = value); + return ( cache[ key + " " ] = value ); } return cache; } @@ -918,17 +930,19 @@ function markFunction( fn ) { * @param {Function} fn Passed the created element and returns a boolean result */ function assert( fn ) { - var el = document.createElement("fieldset"); + var el = document.createElement( "fieldset" ); try { return !!fn( el ); - } catch (e) { + } catch ( e ) { return false; } finally { + // Remove from its parent by default if ( el.parentNode ) { el.parentNode.removeChild( el ); } + // release memory in IE el = null; } @@ -940,11 +954,11 @@ function assert( fn ) { * @param {Function} handler The method that will be applied */ function addHandle( attrs, handler ) { - var arr = attrs.split("|"), + var arr = attrs.split( "|" ), i = arr.length; while ( i-- ) { - Expr.attrHandle[ arr[i] ] = handler; + Expr.attrHandle[ arr[ i ] ] = handler; } } @@ -966,7 +980,7 @@ function siblingCheck( a, b ) { // Check if b follows a if ( cur ) { - while ( (cur = cur.nextSibling) ) { + while ( ( cur = cur.nextSibling ) ) { if ( cur === b ) { return -1; } @@ -994,7 +1008,7 @@ function createInputPseudo( type ) { function createButtonPseudo( type ) { return function( elem ) { var name = elem.nodeName.toLowerCase(); - return (name === "input" || name === "button") && elem.type === type; + return ( name === "input" || name === "button" ) && elem.type === type; }; } @@ -1037,7 +1051,7 @@ function createDisabledPseudo( disabled ) { // Where there is no isDisabled, check manually /* jshint -W018 */ elem.isDisabled !== !disabled && - disabledAncestor( elem ) === disabled; + inDisabledFieldset( elem ) === disabled; } return elem.disabled === disabled; @@ -1059,21 +1073,21 @@ function createDisabledPseudo( disabled ) { * @param {Function} fn */ function createPositionalPseudo( fn ) { - return markFunction(function( argument ) { + return markFunction( function( argument ) { argument = +argument; - return markFunction(function( seed, matches ) { + return markFunction( function( seed, matches ) { var j, matchIndexes = fn( [], seed.length, argument ), i = matchIndexes.length; // Match elements found at the specified indexes while ( i-- ) { - if ( seed[ (j = matchIndexes[i]) ] ) { - seed[j] = !(matches[j] = seed[j]); + if ( seed[ ( j = matchIndexes[ i ] ) ] ) { + seed[ j ] = !( matches[ j ] = seed[ j ] ); } } - }); - }); + } ); + } ); } /** @@ -1094,10 +1108,13 @@ support = Sizzle.support = {}; * @returns {Boolean} True iff elem is a non-HTML XML node */ isXML = Sizzle.isXML = function( elem ) { - // documentElement is verified for cases where it doesn't yet exist - // (such as loading iframes in IE - #4833) - var documentElement = elem && (elem.ownerDocument || elem).documentElement; - return documentElement ? documentElement.nodeName !== "HTML" : false; + var namespace = elem.namespaceURI, + docElem = ( elem.ownerDocument || elem ).documentElement; + + // Support: IE <=8 + // Assume HTML when documentElement doesn't yet exist, such as inside loading iframes + // https://bugs.jquery.com/ticket/4833 + return !rhtml.test( namespace || docElem && docElem.nodeName || "HTML" ); }; /** @@ -1110,7 +1127,11 @@ setDocument = Sizzle.setDocument = function( node ) { doc = node ? node.ownerDocument || node : preferredDoc; // Return early if doc is invalid or already selected - if ( doc === document || doc.nodeType !== 9 || !doc.documentElement ) { + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( doc == document || doc.nodeType !== 9 || !doc.documentElement ) { return document; } @@ -1119,10 +1140,14 @@ setDocument = Sizzle.setDocument = function( node ) { docElem = document.documentElement; documentIsHTML = !isXML( document ); - // Support: IE 9-11, Edge + // Support: IE 9 - 11+, Edge 12 - 18+ // Accessing iframe documents after unload throws "permission denied" errors (jQuery #13936) - if ( preferredDoc !== document && - (subWindow = document.defaultView) && subWindow.top !== subWindow ) { + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( preferredDoc != document && + ( subWindow = document.defaultView ) && subWindow.top !== subWindow ) { // Support: IE 11, Edge if ( subWindow.addEventListener ) { @@ -1134,25 +1159,36 @@ setDocument = Sizzle.setDocument = function( node ) { } } + // Support: IE 8 - 11+, Edge 12 - 18+, Chrome <=16 - 25 only, Firefox <=3.6 - 31 only, + // Safari 4 - 5 only, Opera <=11.6 - 12.x only + // IE/Edge & older browsers don't support the :scope pseudo-class. + // Support: Safari 6.0 only + // Safari 6.0 supports :scope but it's an alias of :root there. + support.scope = assert( function( el ) { + docElem.appendChild( el ).appendChild( document.createElement( "div" ) ); + return typeof el.querySelectorAll !== "undefined" && + !el.querySelectorAll( ":scope fieldset div" ).length; + } ); + /* Attributes ---------------------------------------------------------------------- */ // Support: IE<8 // Verify that getAttribute really returns attributes and not properties // (excepting IE8 booleans) - support.attributes = assert(function( el ) { + support.attributes = assert( function( el ) { el.className = "i"; - return !el.getAttribute("className"); - }); + return !el.getAttribute( "className" ); + } ); /* getElement(s)By* ---------------------------------------------------------------------- */ // Check if getElementsByTagName("*") returns only elements - support.getElementsByTagName = assert(function( el ) { - el.appendChild( document.createComment("") ); - return !el.getElementsByTagName("*").length; - }); + support.getElementsByTagName = assert( function( el ) { + el.appendChild( document.createComment( "" ) ); + return !el.getElementsByTagName( "*" ).length; + } ); // Support: IE<9 support.getElementsByClassName = rnative.test( document.getElementsByClassName ); @@ -1161,38 +1197,38 @@ setDocument = Sizzle.setDocument = function( node ) { // Check if getElementById returns elements by name // The broken getElementById methods don't pick up programmatically-set names, // so use a roundabout getElementsByName test - support.getById = assert(function( el ) { + support.getById = assert( function( el ) { docElem.appendChild( el ).id = expando; return !document.getElementsByName || !document.getElementsByName( expando ).length; - }); + } ); // ID filter and find if ( support.getById ) { - Expr.filter["ID"] = function( id ) { + Expr.filter[ "ID" ] = function( id ) { var attrId = id.replace( runescape, funescape ); return function( elem ) { - return elem.getAttribute("id") === attrId; + return elem.getAttribute( "id" ) === attrId; }; }; - Expr.find["ID"] = function( id, context ) { + Expr.find[ "ID" ] = function( id, context ) { if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { var elem = context.getElementById( id ); return elem ? [ elem ] : []; } }; } else { - Expr.filter["ID"] = function( id ) { + Expr.filter[ "ID" ] = function( id ) { var attrId = id.replace( runescape, funescape ); return function( elem ) { var node = typeof elem.getAttributeNode !== "undefined" && - elem.getAttributeNode("id"); + elem.getAttributeNode( "id" ); return node && node.value === attrId; }; }; // Support: IE 6 - 7 only // getElementById is not reliable as a find shortcut - Expr.find["ID"] = function( id, context ) { + Expr.find[ "ID" ] = function( id, context ) { if ( typeof context.getElementById !== "undefined" && documentIsHTML ) { var node, i, elems, elem = context.getElementById( id ); @@ -1200,7 +1236,7 @@ setDocument = Sizzle.setDocument = function( node ) { if ( elem ) { // Verify the id attribute - node = elem.getAttributeNode("id"); + node = elem.getAttributeNode( "id" ); if ( node && node.value === id ) { return [ elem ]; } @@ -1208,8 +1244,8 @@ setDocument = Sizzle.setDocument = function( node ) { // Fall back on getElementsByName elems = context.getElementsByName( id ); i = 0; - while ( (elem = elems[i++]) ) { - node = elem.getAttributeNode("id"); + while ( ( elem = elems[ i++ ] ) ) { + node = elem.getAttributeNode( "id" ); if ( node && node.value === id ) { return [ elem ]; } @@ -1222,7 +1258,7 @@ setDocument = Sizzle.setDocument = function( node ) { } // Tag - Expr.find["TAG"] = support.getElementsByTagName ? + Expr.find[ "TAG" ] = support.getElementsByTagName ? function( tag, context ) { if ( typeof context.getElementsByTagName !== "undefined" ) { return context.getElementsByTagName( tag ); @@ -1237,12 +1273,13 @@ setDocument = Sizzle.setDocument = function( node ) { var elem, tmp = [], i = 0, + // By happy coincidence, a (broken) gEBTN appears on DocumentFragment nodes too results = context.getElementsByTagName( tag ); // Filter out possible comments if ( tag === "*" ) { - while ( (elem = results[i++]) ) { + while ( ( elem = results[ i++ ] ) ) { if ( elem.nodeType === 1 ) { tmp.push( elem ); } @@ -1254,7 +1291,7 @@ setDocument = Sizzle.setDocument = function( node ) { }; // Class - Expr.find["CLASS"] = support.getElementsByClassName && function( className, context ) { + Expr.find[ "CLASS" ] = support.getElementsByClassName && function( className, context ) { if ( typeof context.getElementsByClassName !== "undefined" && documentIsHTML ) { return context.getElementsByClassName( className ); } @@ -1275,10 +1312,14 @@ setDocument = Sizzle.setDocument = function( node ) { // See https://bugs.jquery.com/ticket/13378 rbuggyQSA = []; - if ( (support.qsa = rnative.test( document.querySelectorAll )) ) { + if ( ( support.qsa = rnative.test( document.querySelectorAll ) ) ) { + // Build QSA regex // Regex strategy adopted from Diego Perini - assert(function( el ) { + assert( function( el ) { + + var input; + // Select is set to empty string on purpose // This is to test IE's treatment of not explicitly // setting a boolean content attribute, @@ -1292,78 +1333,98 @@ setDocument = Sizzle.setDocument = function( node ) { // Nothing should be selected when empty strings follow ^= or $= or *= // The test attribute must be unknown in Opera but "safe" for WinRT // https://msdn.microsoft.com/en-us/library/ie/hh465388.aspx#attribute_section - if ( el.querySelectorAll("[msallowcapture^='']").length ) { + if ( el.querySelectorAll( "[msallowcapture^='']" ).length ) { rbuggyQSA.push( "[*^$]=" + whitespace + "*(?:''|\"\")" ); } // Support: IE8 // Boolean attributes and "value" are not treated correctly - if ( !el.querySelectorAll("[selected]").length ) { + if ( !el.querySelectorAll( "[selected]" ).length ) { rbuggyQSA.push( "\\[" + whitespace + "*(?:value|" + booleans + ")" ); } // Support: Chrome<29, Android<4.4, Safari<7.0+, iOS<7.0+, PhantomJS<1.9.8+ if ( !el.querySelectorAll( "[id~=" + expando + "-]" ).length ) { - rbuggyQSA.push("~="); + rbuggyQSA.push( "~=" ); + } + + // Support: IE 11+, Edge 15 - 18+ + // IE 11/Edge don't find elements on a `[name='']` query in some cases. + // Adding a temporary attribute to the document before the selection works + // around the issue. + // Interestingly, IE 10 & older don't seem to have the issue. + input = document.createElement( "input" ); + input.setAttribute( "name", "" ); + el.appendChild( input ); + if ( !el.querySelectorAll( "[name='']" ).length ) { + rbuggyQSA.push( "\\[" + whitespace + "*name" + whitespace + "*=" + + whitespace + "*(?:''|\"\")" ); } // Webkit/Opera - :checked should return selected option elements // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked // IE8 throws error here and will not see later tests - if ( !el.querySelectorAll(":checked").length ) { - rbuggyQSA.push(":checked"); + if ( !el.querySelectorAll( ":checked" ).length ) { + rbuggyQSA.push( ":checked" ); } // Support: Safari 8+, iOS 8+ // https://bugs.webkit.org/show_bug.cgi?id=136851 // In-page `selector#id sibling-combinator selector` fails if ( !el.querySelectorAll( "a#" + expando + "+*" ).length ) { - rbuggyQSA.push(".#.+[+~]"); + rbuggyQSA.push( ".#.+[+~]" ); } - }); - assert(function( el ) { + // Support: Firefox <=3.6 - 5 only + // Old Firefox doesn't throw on a badly-escaped identifier. + el.querySelectorAll( "\\\f" ); + rbuggyQSA.push( "[\\r\\n\\f]" ); + } ); + + assert( function( el ) { el.innerHTML = "" + ""; // Support: Windows 8 Native Apps // The type and name attributes are restricted during .innerHTML assignment - var input = document.createElement("input"); + var input = document.createElement( "input" ); input.setAttribute( "type", "hidden" ); el.appendChild( input ).setAttribute( "name", "D" ); // Support: IE8 // Enforce case-sensitivity of name attribute - if ( el.querySelectorAll("[name=d]").length ) { + if ( el.querySelectorAll( "[name=d]" ).length ) { rbuggyQSA.push( "name" + whitespace + "*[*^$|!~]?=" ); } // FF 3.5 - :enabled/:disabled and hidden elements (hidden elements are still enabled) // IE8 throws error here and will not see later tests - if ( el.querySelectorAll(":enabled").length !== 2 ) { + if ( el.querySelectorAll( ":enabled" ).length !== 2 ) { rbuggyQSA.push( ":enabled", ":disabled" ); } // Support: IE9-11+ // IE's :disabled selector does not pick up the children of disabled fieldsets docElem.appendChild( el ).disabled = true; - if ( el.querySelectorAll(":disabled").length !== 2 ) { + if ( el.querySelectorAll( ":disabled" ).length !== 2 ) { rbuggyQSA.push( ":enabled", ":disabled" ); } + // Support: Opera 10 - 11 only // Opera 10-11 does not throw on post-comma invalid pseudos - el.querySelectorAll("*,:x"); - rbuggyQSA.push(",.*:"); - }); + el.querySelectorAll( "*,:x" ); + rbuggyQSA.push( ",.*:" ); + } ); } - if ( (support.matchesSelector = rnative.test( (matches = docElem.matches || + if ( ( support.matchesSelector = rnative.test( ( matches = docElem.matches || docElem.webkitMatchesSelector || docElem.mozMatchesSelector || docElem.oMatchesSelector || - docElem.msMatchesSelector) )) ) { + docElem.msMatchesSelector ) ) ) ) { + + assert( function( el ) { - assert(function( el ) { // Check to see if it's possible to do matchesSelector // on a disconnected node (IE 9) support.disconnectedMatch = matches.call( el, "*" ); @@ -1372,11 +1433,11 @@ setDocument = Sizzle.setDocument = function( node ) { // Gecko does not error, returns false instead matches.call( el, "[s!='']:x" ); rbuggyMatches.push( "!=", pseudos ); - }); + } ); } - rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join("|") ); - rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join("|") ); + rbuggyQSA = rbuggyQSA.length && new RegExp( rbuggyQSA.join( "|" ) ); + rbuggyMatches = rbuggyMatches.length && new RegExp( rbuggyMatches.join( "|" ) ); /* Contains ---------------------------------------------------------------------- */ @@ -1393,11 +1454,11 @@ setDocument = Sizzle.setDocument = function( node ) { adown.contains ? adown.contains( bup ) : a.compareDocumentPosition && a.compareDocumentPosition( bup ) & 16 - )); + ) ); } : function( a, b ) { if ( b ) { - while ( (b = b.parentNode) ) { + while ( ( b = b.parentNode ) ) { if ( b === a ) { return true; } @@ -1426,7 +1487,11 @@ setDocument = Sizzle.setDocument = function( node ) { } // Calculate position if both inputs belong to the same document - compare = ( a.ownerDocument || a ) === ( b.ownerDocument || b ) ? + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + compare = ( a.ownerDocument || a ) == ( b.ownerDocument || b ) ? a.compareDocumentPosition( b ) : // Otherwise we know they are disconnected @@ -1434,13 +1499,24 @@ setDocument = Sizzle.setDocument = function( node ) { // Disconnected nodes if ( compare & 1 || - (!support.sortDetached && b.compareDocumentPosition( a ) === compare) ) { + ( !support.sortDetached && b.compareDocumentPosition( a ) === compare ) ) { // Choose the first element that is related to our preferred document - if ( a === document || a.ownerDocument === preferredDoc && contains(preferredDoc, a) ) { + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( a == document || a.ownerDocument == preferredDoc && + contains( preferredDoc, a ) ) { return -1; } - if ( b === document || b.ownerDocument === preferredDoc && contains(preferredDoc, b) ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( b == document || b.ownerDocument == preferredDoc && + contains( preferredDoc, b ) ) { return 1; } @@ -1453,6 +1529,7 @@ setDocument = Sizzle.setDocument = function( node ) { return compare & 4 ? -1 : 1; } : function( a, b ) { + // Exit early if the nodes are identical if ( a === b ) { hasDuplicate = true; @@ -1468,8 +1545,14 @@ setDocument = Sizzle.setDocument = function( node ) { // Parentless nodes are either documents or disconnected if ( !aup || !bup ) { - return a === document ? -1 : - b === document ? 1 : + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + return a == document ? -1 : + b == document ? 1 : + /* eslint-enable eqeqeq */ aup ? -1 : bup ? 1 : sortInput ? @@ -1483,26 +1566,32 @@ setDocument = Sizzle.setDocument = function( node ) { // Otherwise we need full lists of their ancestors for comparison cur = a; - while ( (cur = cur.parentNode) ) { + while ( ( cur = cur.parentNode ) ) { ap.unshift( cur ); } cur = b; - while ( (cur = cur.parentNode) ) { + while ( ( cur = cur.parentNode ) ) { bp.unshift( cur ); } // Walk down the tree looking for a discrepancy - while ( ap[i] === bp[i] ) { + while ( ap[ i ] === bp[ i ] ) { i++; } return i ? + // Do a sibling check if the nodes have a common ancestor - siblingCheck( ap[i], bp[i] ) : + siblingCheck( ap[ i ], bp[ i ] ) : // Otherwise nodes in our document sort first - ap[i] === preferredDoc ? -1 : - bp[i] === preferredDoc ? 1 : + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + /* eslint-disable eqeqeq */ + ap[ i ] == preferredDoc ? -1 : + bp[ i ] == preferredDoc ? 1 : + /* eslint-enable eqeqeq */ 0; }; @@ -1514,16 +1603,10 @@ Sizzle.matches = function( expr, elements ) { }; Sizzle.matchesSelector = function( elem, expr ) { - // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { - setDocument( elem ); - } - - // Make sure that attribute selectors are quoted - expr = expr.replace( rattributeQuotes, "='$1']" ); + setDocument( elem ); if ( support.matchesSelector && documentIsHTML && - !compilerCache[ expr + " " ] && + !nonnativeSelectorCache[ expr + " " ] && ( !rbuggyMatches || !rbuggyMatches.test( expr ) ) && ( !rbuggyQSA || !rbuggyQSA.test( expr ) ) ) { @@ -1532,32 +1615,46 @@ Sizzle.matchesSelector = function( elem, expr ) { // IE 9's matchesSelector returns false on disconnected nodes if ( ret || support.disconnectedMatch || - // As well, disconnected nodes are said to be in a document - // fragment in IE 9 - elem.document && elem.document.nodeType !== 11 ) { + + // As well, disconnected nodes are said to be in a document + // fragment in IE 9 + elem.document && elem.document.nodeType !== 11 ) { return ret; } - } catch (e) {} + } catch ( e ) { + nonnativeSelectorCache( expr, true ); + } } return Sizzle( expr, document, null, [ elem ] ).length > 0; }; Sizzle.contains = function( context, elem ) { + // Set document vars if needed - if ( ( context.ownerDocument || context ) !== document ) { + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( context.ownerDocument || context ) != document ) { setDocument( context ); } return contains( context, elem ); }; Sizzle.attr = function( elem, name ) { + // Set document vars if needed - if ( ( elem.ownerDocument || elem ) !== document ) { + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( ( elem.ownerDocument || elem ) != document ) { setDocument( elem ); } var fn = Expr.attrHandle[ name.toLowerCase() ], + // Don't get fooled by Object.prototype properties (jQuery #13807) val = fn && hasOwn.call( Expr.attrHandle, name.toLowerCase() ) ? fn( elem, name, !documentIsHTML ) : @@ -1567,13 +1664,13 @@ Sizzle.attr = function( elem, name ) { val : support.attributes || !documentIsHTML ? elem.getAttribute( name ) : - (val = elem.getAttributeNode(name)) && val.specified ? + ( val = elem.getAttributeNode( name ) ) && val.specified ? val.value : null; }; Sizzle.escape = function( sel ) { - return (sel + "").replace( rcssescape, fcssescape ); + return ( sel + "" ).replace( rcssescape, fcssescape ); }; Sizzle.error = function( msg ) { @@ -1596,7 +1693,7 @@ Sizzle.uniqueSort = function( results ) { results.sort( sortOrder ); if ( hasDuplicate ) { - while ( (elem = results[i++]) ) { + while ( ( elem = results[ i++ ] ) ) { if ( elem === results[ i ] ) { j = duplicates.push( i ); } @@ -1624,17 +1721,21 @@ getText = Sizzle.getText = function( elem ) { nodeType = elem.nodeType; if ( !nodeType ) { + // If no nodeType, this is expected to be an array - while ( (node = elem[i++]) ) { + while ( ( node = elem[ i++ ] ) ) { + // Do not traverse comment nodes ret += getText( node ); } } else if ( nodeType === 1 || nodeType === 9 || nodeType === 11 ) { + // Use textContent for elements // innerText usage removed for consistency of new lines (jQuery #11153) if ( typeof elem.textContent === "string" ) { return elem.textContent; } else { + // Traverse its children for ( elem = elem.firstChild; elem; elem = elem.nextSibling ) { ret += getText( elem ); @@ -1643,6 +1744,7 @@ getText = Sizzle.getText = function( elem ) { } else if ( nodeType === 3 || nodeType === 4 ) { return elem.nodeValue; } + // Do not include comment or processing instruction nodes return ret; @@ -1670,19 +1772,21 @@ Expr = Sizzle.selectors = { preFilter: { "ATTR": function( match ) { - match[1] = match[1].replace( runescape, funescape ); + match[ 1 ] = match[ 1 ].replace( runescape, funescape ); // Move the given value to match[3] whether quoted or unquoted - match[3] = ( match[3] || match[4] || match[5] || "" ).replace( runescape, funescape ); + match[ 3 ] = ( match[ 3 ] || match[ 4 ] || + match[ 5 ] || "" ).replace( runescape, funescape ); - if ( match[2] === "~=" ) { - match[3] = " " + match[3] + " "; + if ( match[ 2 ] === "~=" ) { + match[ 3 ] = " " + match[ 3 ] + " "; } return match.slice( 0, 4 ); }, "CHILD": function( match ) { + /* matches from matchExpr["CHILD"] 1 type (only|nth|...) 2 what (child|of-type) @@ -1693,22 +1797,25 @@ Expr = Sizzle.selectors = { 7 sign of y-component 8 y of y-component */ - match[1] = match[1].toLowerCase(); + match[ 1 ] = match[ 1 ].toLowerCase(); + + if ( match[ 1 ].slice( 0, 3 ) === "nth" ) { - if ( match[1].slice( 0, 3 ) === "nth" ) { // nth-* requires argument - if ( !match[3] ) { - Sizzle.error( match[0] ); + if ( !match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); } // numeric x and y parameters for Expr.filter.CHILD // remember that false/true cast respectively to 0/1 - match[4] = +( match[4] ? match[5] + (match[6] || 1) : 2 * ( match[3] === "even" || match[3] === "odd" ) ); - match[5] = +( ( match[7] + match[8] ) || match[3] === "odd" ); + match[ 4 ] = +( match[ 4 ] ? + match[ 5 ] + ( match[ 6 ] || 1 ) : + 2 * ( match[ 3 ] === "even" || match[ 3 ] === "odd" ) ); + match[ 5 ] = +( ( match[ 7 ] + match[ 8 ] ) || match[ 3 ] === "odd" ); - // other types prohibit arguments - } else if ( match[3] ) { - Sizzle.error( match[0] ); + // other types prohibit arguments + } else if ( match[ 3 ] ) { + Sizzle.error( match[ 0 ] ); } return match; @@ -1716,26 +1823,28 @@ Expr = Sizzle.selectors = { "PSEUDO": function( match ) { var excess, - unquoted = !match[6] && match[2]; + unquoted = !match[ 6 ] && match[ 2 ]; - if ( matchExpr["CHILD"].test( match[0] ) ) { + if ( matchExpr[ "CHILD" ].test( match[ 0 ] ) ) { return null; } // Accept quoted arguments as-is - if ( match[3] ) { - match[2] = match[4] || match[5] || ""; + if ( match[ 3 ] ) { + match[ 2 ] = match[ 4 ] || match[ 5 ] || ""; // Strip excess characters from unquoted arguments } else if ( unquoted && rpseudo.test( unquoted ) && + // Get excess from tokenize (recursively) - (excess = tokenize( unquoted, true )) && + ( excess = tokenize( unquoted, true ) ) && + // advance to the next closing parenthesis - (excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length) ) { + ( excess = unquoted.indexOf( ")", unquoted.length - excess ) - unquoted.length ) ) { // excess is a negative index - match[0] = match[0].slice( 0, excess ); - match[2] = unquoted.slice( 0, excess ); + match[ 0 ] = match[ 0 ].slice( 0, excess ); + match[ 2 ] = unquoted.slice( 0, excess ); } // Return only captures needed by the pseudo filter method (type and argument) @@ -1748,7 +1857,9 @@ Expr = Sizzle.selectors = { "TAG": function( nodeNameSelector ) { var nodeName = nodeNameSelector.replace( runescape, funescape ).toLowerCase(); return nodeNameSelector === "*" ? - function() { return true; } : + function() { + return true; + } : function( elem ) { return elem.nodeName && elem.nodeName.toLowerCase() === nodeName; }; @@ -1758,10 +1869,16 @@ Expr = Sizzle.selectors = { var pattern = classCache[ className + " " ]; return pattern || - (pattern = new RegExp( "(^|" + whitespace + ")" + className + "(" + whitespace + "|$)" )) && - classCache( className, function( elem ) { - return pattern.test( typeof elem.className === "string" && elem.className || typeof elem.getAttribute !== "undefined" && elem.getAttribute("class") || "" ); - }); + ( pattern = new RegExp( "(^|" + whitespace + + ")" + className + "(" + whitespace + "|$)" ) ) && classCache( + className, function( elem ) { + return pattern.test( + typeof elem.className === "string" && elem.className || + typeof elem.getAttribute !== "undefined" && + elem.getAttribute( "class" ) || + "" + ); + } ); }, "ATTR": function( name, operator, check ) { @@ -1777,6 +1894,8 @@ Expr = Sizzle.selectors = { result += ""; + /* eslint-disable max-len */ + return operator === "=" ? result === check : operator === "!=" ? result !== check : operator === "^=" ? check && result.indexOf( check ) === 0 : @@ -1785,10 +1904,12 @@ Expr = Sizzle.selectors = { operator === "~=" ? ( " " + result.replace( rwhitespace, " " ) + " " ).indexOf( check ) > -1 : operator === "|=" ? result === check || result.slice( 0, check.length + 1 ) === check + "-" : false; + /* eslint-enable max-len */ + }; }, - "CHILD": function( type, what, argument, first, last ) { + "CHILD": function( type, what, _argument, first, last ) { var simple = type.slice( 0, 3 ) !== "nth", forward = type.slice( -4 ) !== "last", ofType = what === "of-type"; @@ -1800,7 +1921,7 @@ Expr = Sizzle.selectors = { return !!elem.parentNode; } : - function( elem, context, xml ) { + function( elem, _context, xml ) { var cache, uniqueCache, outerCache, node, nodeIndex, start, dir = simple !== forward ? "nextSibling" : "previousSibling", parent = elem.parentNode, @@ -1814,7 +1935,7 @@ Expr = Sizzle.selectors = { if ( simple ) { while ( dir ) { node = elem; - while ( (node = node[ dir ]) ) { + while ( ( node = node[ dir ] ) ) { if ( ofType ? node.nodeName.toLowerCase() === name : node.nodeType === 1 ) { @@ -1822,6 +1943,7 @@ Expr = Sizzle.selectors = { return false; } } + // Reverse direction for :only-* (if we haven't yet done so) start = dir = type === "only" && !start && "nextSibling"; } @@ -1837,22 +1959,22 @@ Expr = Sizzle.selectors = { // ...in a gzip-friendly way node = parent; - outerCache = node[ expando ] || (node[ expando ] = {}); + outerCache = node[ expando ] || ( node[ expando ] = {} ); // Support: IE <9 only // Defend against cloned attroperties (jQuery gh-1709) uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); + ( outerCache[ node.uniqueID ] = {} ); cache = uniqueCache[ type ] || []; nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; diff = nodeIndex && cache[ 2 ]; node = nodeIndex && parent.childNodes[ nodeIndex ]; - while ( (node = ++nodeIndex && node && node[ dir ] || + while ( ( node = ++nodeIndex && node && node[ dir ] || // Fallback to seeking `elem` from the start - (diff = nodeIndex = 0) || start.pop()) ) { + ( diff = nodeIndex = 0 ) || start.pop() ) ) { // When found, cache indexes on `parent` and break if ( node.nodeType === 1 && ++diff && node === elem ) { @@ -1862,16 +1984,18 @@ Expr = Sizzle.selectors = { } } else { + // Use previously-cached element index if available if ( useCache ) { + // ...in a gzip-friendly way node = elem; - outerCache = node[ expando ] || (node[ expando ] = {}); + outerCache = node[ expando ] || ( node[ expando ] = {} ); // Support: IE <9 only // Defend against cloned attroperties (jQuery gh-1709) uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); + ( outerCache[ node.uniqueID ] = {} ); cache = uniqueCache[ type ] || []; nodeIndex = cache[ 0 ] === dirruns && cache[ 1 ]; @@ -1881,9 +2005,10 @@ Expr = Sizzle.selectors = { // xml :nth-child(...) // or :nth-last-child(...) or :nth(-last)?-of-type(...) if ( diff === false ) { + // Use the same loop as above to seek `elem` from the start - while ( (node = ++nodeIndex && node && node[ dir ] || - (diff = nodeIndex = 0) || start.pop()) ) { + while ( ( node = ++nodeIndex && node && node[ dir ] || + ( diff = nodeIndex = 0 ) || start.pop() ) ) { if ( ( ofType ? node.nodeName.toLowerCase() === name : @@ -1892,12 +2017,13 @@ Expr = Sizzle.selectors = { // Cache the index of each encountered element if ( useCache ) { - outerCache = node[ expando ] || (node[ expando ] = {}); + outerCache = node[ expando ] || + ( node[ expando ] = {} ); // Support: IE <9 only // Defend against cloned attroperties (jQuery gh-1709) uniqueCache = outerCache[ node.uniqueID ] || - (outerCache[ node.uniqueID ] = {}); + ( outerCache[ node.uniqueID ] = {} ); uniqueCache[ type ] = [ dirruns, diff ]; } @@ -1918,6 +2044,7 @@ Expr = Sizzle.selectors = { }, "PSEUDO": function( pseudo, argument ) { + // pseudo-class names are case-insensitive // http://www.w3.org/TR/selectors/#pseudo-classes // Prioritize by case sensitivity in case custom pseudos are added with uppercase letters @@ -1937,15 +2064,15 @@ Expr = Sizzle.selectors = { if ( fn.length > 1 ) { args = [ pseudo, pseudo, "", argument ]; return Expr.setFilters.hasOwnProperty( pseudo.toLowerCase() ) ? - markFunction(function( seed, matches ) { + markFunction( function( seed, matches ) { var idx, matched = fn( seed, argument ), i = matched.length; while ( i-- ) { - idx = indexOf( seed, matched[i] ); - seed[ idx ] = !( matches[ idx ] = matched[i] ); + idx = indexOf( seed, matched[ i ] ); + seed[ idx ] = !( matches[ idx ] = matched[ i ] ); } - }) : + } ) : function( elem ) { return fn( elem, 0, args ); }; @@ -1956,8 +2083,10 @@ Expr = Sizzle.selectors = { }, pseudos: { + // Potentially complex pseudos - "not": markFunction(function( selector ) { + "not": markFunction( function( selector ) { + // Trim the selector passed to compile // to avoid treating leading and trailing // spaces as combinators @@ -1966,39 +2095,40 @@ Expr = Sizzle.selectors = { matcher = compile( selector.replace( rtrim, "$1" ) ); return matcher[ expando ] ? - markFunction(function( seed, matches, context, xml ) { + markFunction( function( seed, matches, _context, xml ) { var elem, unmatched = matcher( seed, null, xml, [] ), i = seed.length; // Match elements unmatched by `matcher` while ( i-- ) { - if ( (elem = unmatched[i]) ) { - seed[i] = !(matches[i] = elem); + if ( ( elem = unmatched[ i ] ) ) { + seed[ i ] = !( matches[ i ] = elem ); } } - }) : - function( elem, context, xml ) { - input[0] = elem; + } ) : + function( elem, _context, xml ) { + input[ 0 ] = elem; matcher( input, null, xml, results ); + // Don't keep the element (issue #299) - input[0] = null; + input[ 0 ] = null; return !results.pop(); }; - }), + } ), - "has": markFunction(function( selector ) { + "has": markFunction( function( selector ) { return function( elem ) { return Sizzle( selector, elem ).length > 0; }; - }), + } ), - "contains": markFunction(function( text ) { + "contains": markFunction( function( text ) { text = text.replace( runescape, funescape ); return function( elem ) { - return ( elem.textContent || elem.innerText || getText( elem ) ).indexOf( text ) > -1; + return ( elem.textContent || getText( elem ) ).indexOf( text ) > -1; }; - }), + } ), // "Whether an element is represented by a :lang() selector // is based solely on the element's language value @@ -2008,25 +2138,26 @@ Expr = Sizzle.selectors = { // The identifier C does not have to be a valid language name." // http://www.w3.org/TR/selectors/#lang-pseudo "lang": markFunction( function( lang ) { + // lang value must be a valid identifier - if ( !ridentifier.test(lang || "") ) { + if ( !ridentifier.test( lang || "" ) ) { Sizzle.error( "unsupported lang: " + lang ); } lang = lang.replace( runescape, funescape ).toLowerCase(); return function( elem ) { var elemLang; do { - if ( (elemLang = documentIsHTML ? + if ( ( elemLang = documentIsHTML ? elem.lang : - elem.getAttribute("xml:lang") || elem.getAttribute("lang")) ) { + elem.getAttribute( "xml:lang" ) || elem.getAttribute( "lang" ) ) ) { elemLang = elemLang.toLowerCase(); return elemLang === lang || elemLang.indexOf( lang + "-" ) === 0; } - } while ( (elem = elem.parentNode) && elem.nodeType === 1 ); + } while ( ( elem = elem.parentNode ) && elem.nodeType === 1 ); return false; }; - }), + } ), // Miscellaneous "target": function( elem ) { @@ -2039,7 +2170,9 @@ Expr = Sizzle.selectors = { }, "focus": function( elem ) { - return elem === document.activeElement && (!document.hasFocus || document.hasFocus()) && !!(elem.type || elem.href || ~elem.tabIndex); + return elem === document.activeElement && + ( !document.hasFocus || document.hasFocus() ) && + !!( elem.type || elem.href || ~elem.tabIndex ); }, // Boolean properties @@ -2047,16 +2180,20 @@ Expr = Sizzle.selectors = { "disabled": createDisabledPseudo( true ), "checked": function( elem ) { + // In CSS3, :checked should return both checked and selected elements // http://www.w3.org/TR/2011/REC-css3-selectors-20110929/#checked var nodeName = elem.nodeName.toLowerCase(); - return (nodeName === "input" && !!elem.checked) || (nodeName === "option" && !!elem.selected); + return ( nodeName === "input" && !!elem.checked ) || + ( nodeName === "option" && !!elem.selected ); }, "selected": function( elem ) { + // Accessing this property makes selected-by-default // options in Safari work properly if ( elem.parentNode ) { + // eslint-disable-next-line no-unused-expressions elem.parentNode.selectedIndex; } @@ -2065,6 +2202,7 @@ Expr = Sizzle.selectors = { // Contents "empty": function( elem ) { + // http://www.w3.org/TR/selectors/#empty-pseudo // :empty is negated by element (1) or content nodes (text: 3; cdata: 4; entity ref: 5), // but not by others (comment: 8; processing instruction: 7; etc.) @@ -2078,7 +2216,7 @@ Expr = Sizzle.selectors = { }, "parent": function( elem ) { - return !Expr.pseudos["empty"]( elem ); + return !Expr.pseudos[ "empty" ]( elem ); }, // Element/input types @@ -2102,57 +2240,62 @@ Expr = Sizzle.selectors = { // Support: IE<8 // New HTML5 attribute values (e.g., "search") appear with elem.type === "text" - ( (attr = elem.getAttribute("type")) == null || attr.toLowerCase() === "text" ); + ( ( attr = elem.getAttribute( "type" ) ) == null || + attr.toLowerCase() === "text" ); }, // Position-in-collection - "first": createPositionalPseudo(function() { + "first": createPositionalPseudo( function() { return [ 0 ]; - }), + } ), - "last": createPositionalPseudo(function( matchIndexes, length ) { + "last": createPositionalPseudo( function( _matchIndexes, length ) { return [ length - 1 ]; - }), + } ), - "eq": createPositionalPseudo(function( matchIndexes, length, argument ) { + "eq": createPositionalPseudo( function( _matchIndexes, length, argument ) { return [ argument < 0 ? argument + length : argument ]; - }), + } ), - "even": createPositionalPseudo(function( matchIndexes, length ) { + "even": createPositionalPseudo( function( matchIndexes, length ) { var i = 0; for ( ; i < length; i += 2 ) { matchIndexes.push( i ); } return matchIndexes; - }), + } ), - "odd": createPositionalPseudo(function( matchIndexes, length ) { + "odd": createPositionalPseudo( function( matchIndexes, length ) { var i = 1; for ( ; i < length; i += 2 ) { matchIndexes.push( i ); } return matchIndexes; - }), + } ), - "lt": createPositionalPseudo(function( matchIndexes, length, argument ) { - var i = argument < 0 ? argument + length : argument; + "lt": createPositionalPseudo( function( matchIndexes, length, argument ) { + var i = argument < 0 ? + argument + length : + argument > length ? + length : + argument; for ( ; --i >= 0; ) { matchIndexes.push( i ); } return matchIndexes; - }), + } ), - "gt": createPositionalPseudo(function( matchIndexes, length, argument ) { + "gt": createPositionalPseudo( function( matchIndexes, length, argument ) { var i = argument < 0 ? argument + length : argument; for ( ; ++i < length; ) { matchIndexes.push( i ); } return matchIndexes; - }) + } ) } }; -Expr.pseudos["nth"] = Expr.pseudos["eq"]; +Expr.pseudos[ "nth" ] = Expr.pseudos[ "eq" ]; // Add button/input type pseudos for ( i in { radio: true, checkbox: true, file: true, password: true, image: true } ) { @@ -2183,37 +2326,39 @@ tokenize = Sizzle.tokenize = function( selector, parseOnly ) { while ( soFar ) { // Comma and first run - if ( !matched || (match = rcomma.exec( soFar )) ) { + if ( !matched || ( match = rcomma.exec( soFar ) ) ) { if ( match ) { + // Don't consume trailing commas as valid - soFar = soFar.slice( match[0].length ) || soFar; + soFar = soFar.slice( match[ 0 ].length ) || soFar; } - groups.push( (tokens = []) ); + groups.push( ( tokens = [] ) ); } matched = false; // Combinators - if ( (match = rcombinators.exec( soFar )) ) { + if ( ( match = rcombinators.exec( soFar ) ) ) { matched = match.shift(); - tokens.push({ + tokens.push( { value: matched, + // Cast descendant combinators to space - type: match[0].replace( rtrim, " " ) - }); + type: match[ 0 ].replace( rtrim, " " ) + } ); soFar = soFar.slice( matched.length ); } // Filters for ( type in Expr.filter ) { - if ( (match = matchExpr[ type ].exec( soFar )) && (!preFilters[ type ] || - (match = preFilters[ type ]( match ))) ) { + if ( ( match = matchExpr[ type ].exec( soFar ) ) && ( !preFilters[ type ] || + ( match = preFilters[ type ]( match ) ) ) ) { matched = match.shift(); - tokens.push({ + tokens.push( { value: matched, type: type, matches: match - }); + } ); soFar = soFar.slice( matched.length ); } } @@ -2230,6 +2375,7 @@ tokenize = Sizzle.tokenize = function( selector, parseOnly ) { soFar.length : soFar ? Sizzle.error( selector ) : + // Cache the tokens tokenCache( selector, groups ).slice( 0 ); }; @@ -2239,7 +2385,7 @@ function toSelector( tokens ) { len = tokens.length, selector = ""; for ( ; i < len; i++ ) { - selector += tokens[i].value; + selector += tokens[ i ].value; } return selector; } @@ -2252,9 +2398,10 @@ function addCombinator( matcher, combinator, base ) { doneName = done++; return combinator.first ? + // Check against closest ancestor/preceding element function( elem, context, xml ) { - while ( (elem = elem[ dir ]) ) { + while ( ( elem = elem[ dir ] ) ) { if ( elem.nodeType === 1 || checkNonElements ) { return matcher( elem, context, xml ); } @@ -2269,7 +2416,7 @@ function addCombinator( matcher, combinator, base ) { // We can't set arbitrary data on XML nodes, so they don't benefit from combinator caching if ( xml ) { - while ( (elem = elem[ dir ]) ) { + while ( ( elem = elem[ dir ] ) ) { if ( elem.nodeType === 1 || checkNonElements ) { if ( matcher( elem, context, xml ) ) { return true; @@ -2277,27 +2424,29 @@ function addCombinator( matcher, combinator, base ) { } } } else { - while ( (elem = elem[ dir ]) ) { + while ( ( elem = elem[ dir ] ) ) { if ( elem.nodeType === 1 || checkNonElements ) { - outerCache = elem[ expando ] || (elem[ expando ] = {}); + outerCache = elem[ expando ] || ( elem[ expando ] = {} ); // Support: IE <9 only // Defend against cloned attroperties (jQuery gh-1709) - uniqueCache = outerCache[ elem.uniqueID ] || (outerCache[ elem.uniqueID ] = {}); + uniqueCache = outerCache[ elem.uniqueID ] || + ( outerCache[ elem.uniqueID ] = {} ); if ( skip && skip === elem.nodeName.toLowerCase() ) { elem = elem[ dir ] || elem; - } else if ( (oldCache = uniqueCache[ key ]) && + } else if ( ( oldCache = uniqueCache[ key ] ) && oldCache[ 0 ] === dirruns && oldCache[ 1 ] === doneName ) { // Assign to newCache so results back-propagate to previous elements - return (newCache[ 2 ] = oldCache[ 2 ]); + return ( newCache[ 2 ] = oldCache[ 2 ] ); } else { + // Reuse newcache so results back-propagate to previous elements uniqueCache[ key ] = newCache; // A match means we're done; a fail means we have to keep checking - if ( (newCache[ 2 ] = matcher( elem, context, xml )) ) { + if ( ( newCache[ 2 ] = matcher( elem, context, xml ) ) ) { return true; } } @@ -2313,20 +2462,20 @@ function elementMatcher( matchers ) { function( elem, context, xml ) { var i = matchers.length; while ( i-- ) { - if ( !matchers[i]( elem, context, xml ) ) { + if ( !matchers[ i ]( elem, context, xml ) ) { return false; } } return true; } : - matchers[0]; + matchers[ 0 ]; } function multipleContexts( selector, contexts, results ) { var i = 0, len = contexts.length; for ( ; i < len; i++ ) { - Sizzle( selector, contexts[i], results ); + Sizzle( selector, contexts[ i ], results ); } return results; } @@ -2339,7 +2488,7 @@ function condense( unmatched, map, filter, context, xml ) { mapped = map != null; for ( ; i < len; i++ ) { - if ( (elem = unmatched[i]) ) { + if ( ( elem = unmatched[ i ] ) ) { if ( !filter || filter( elem, context, xml ) ) { newUnmatched.push( elem ); if ( mapped ) { @@ -2359,14 +2508,18 @@ function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postS if ( postFinder && !postFinder[ expando ] ) { postFinder = setMatcher( postFinder, postSelector ); } - return markFunction(function( seed, results, context, xml ) { + return markFunction( function( seed, results, context, xml ) { var temp, i, elem, preMap = [], postMap = [], preexisting = results.length, // Get initial elements from seed or context - elems = seed || multipleContexts( selector || "*", context.nodeType ? [ context ] : context, [] ), + elems = seed || multipleContexts( + selector || "*", + context.nodeType ? [ context ] : context, + [] + ), // Prefilter to get matcher input, preserving a map for seed-results synchronization matcherIn = preFilter && ( seed || !selector ) ? @@ -2374,6 +2527,7 @@ function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postS elems, matcherOut = matcher ? + // If we have a postFinder, or filtered seed, or non-seed postFilter or preexisting results, postFinder || ( seed ? preFilter : preexisting || postFilter ) ? @@ -2397,8 +2551,8 @@ function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postS // Un-match failing elements by moving them back to matcherIn i = temp.length; while ( i-- ) { - if ( (elem = temp[i]) ) { - matcherOut[ postMap[i] ] = !(matcherIn[ postMap[i] ] = elem); + if ( ( elem = temp[ i ] ) ) { + matcherOut[ postMap[ i ] ] = !( matcherIn[ postMap[ i ] ] = elem ); } } } @@ -2406,25 +2560,27 @@ function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postS if ( seed ) { if ( postFinder || preFilter ) { if ( postFinder ) { + // Get the final matcherOut by condensing this intermediate into postFinder contexts temp = []; i = matcherOut.length; while ( i-- ) { - if ( (elem = matcherOut[i]) ) { + if ( ( elem = matcherOut[ i ] ) ) { + // Restore matcherIn since elem is not yet a final match - temp.push( (matcherIn[i] = elem) ); + temp.push( ( matcherIn[ i ] = elem ) ); } } - postFinder( null, (matcherOut = []), temp, xml ); + postFinder( null, ( matcherOut = [] ), temp, xml ); } // Move matched elements from seed to results to keep them synchronized i = matcherOut.length; while ( i-- ) { - if ( (elem = matcherOut[i]) && - (temp = postFinder ? indexOf( seed, elem ) : preMap[i]) > -1 ) { + if ( ( elem = matcherOut[ i ] ) && + ( temp = postFinder ? indexOf( seed, elem ) : preMap[ i ] ) > -1 ) { - seed[temp] = !(results[temp] = elem); + seed[ temp ] = !( results[ temp ] = elem ); } } } @@ -2442,14 +2598,14 @@ function setMatcher( preFilter, selector, matcher, postFilter, postFinder, postS push.apply( results, matcherOut ); } } - }); + } ); } function matcherFromTokens( tokens ) { var checkContext, matcher, j, len = tokens.length, - leadingRelative = Expr.relative[ tokens[0].type ], - implicitRelative = leadingRelative || Expr.relative[" "], + leadingRelative = Expr.relative[ tokens[ 0 ].type ], + implicitRelative = leadingRelative || Expr.relative[ " " ], i = leadingRelative ? 1 : 0, // The foundational matcher ensures that elements are reachable from top-level context(s) @@ -2461,38 +2617,43 @@ function matcherFromTokens( tokens ) { }, implicitRelative, true ), matchers = [ function( elem, context, xml ) { var ret = ( !leadingRelative && ( xml || context !== outermostContext ) ) || ( - (checkContext = context).nodeType ? + ( checkContext = context ).nodeType ? matchContext( elem, context, xml ) : matchAnyContext( elem, context, xml ) ); + // Avoid hanging onto element (issue #299) checkContext = null; return ret; } ]; for ( ; i < len; i++ ) { - if ( (matcher = Expr.relative[ tokens[i].type ]) ) { - matchers = [ addCombinator(elementMatcher( matchers ), matcher) ]; + if ( ( matcher = Expr.relative[ tokens[ i ].type ] ) ) { + matchers = [ addCombinator( elementMatcher( matchers ), matcher ) ]; } else { - matcher = Expr.filter[ tokens[i].type ].apply( null, tokens[i].matches ); + matcher = Expr.filter[ tokens[ i ].type ].apply( null, tokens[ i ].matches ); // Return special upon seeing a positional matcher if ( matcher[ expando ] ) { + // Find the next relative operator (if any) for proper handling j = ++i; for ( ; j < len; j++ ) { - if ( Expr.relative[ tokens[j].type ] ) { + if ( Expr.relative[ tokens[ j ].type ] ) { break; } } return setMatcher( i > 1 && elementMatcher( matchers ), i > 1 && toSelector( - // If the preceding token was a descendant combinator, insert an implicit any-element `*` - tokens.slice( 0, i - 1 ).concat({ value: tokens[ i - 2 ].type === " " ? "*" : "" }) + + // If the preceding token was a descendant combinator, insert an implicit any-element `*` + tokens + .slice( 0, i - 1 ) + .concat( { value: tokens[ i - 2 ].type === " " ? "*" : "" } ) ).replace( rtrim, "$1" ), matcher, i < j && matcherFromTokens( tokens.slice( i, j ) ), - j < len && matcherFromTokens( (tokens = tokens.slice( j )) ), + j < len && matcherFromTokens( ( tokens = tokens.slice( j ) ) ), j < len && toSelector( tokens ) ); } @@ -2513,28 +2674,40 @@ function matcherFromGroupMatchers( elementMatchers, setMatchers ) { unmatched = seed && [], setMatched = [], contextBackup = outermostContext, + // We must always have either seed elements or outermost context - elems = seed || byElement && Expr.find["TAG"]( "*", outermost ), + elems = seed || byElement && Expr.find[ "TAG" ]( "*", outermost ), + // Use integer dirruns iff this is the outermost matcher - dirrunsUnique = (dirruns += contextBackup == null ? 1 : Math.random() || 0.1), + dirrunsUnique = ( dirruns += contextBackup == null ? 1 : Math.random() || 0.1 ), len = elems.length; if ( outermost ) { - outermostContext = context === document || context || outermost; + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + outermostContext = context == document || context || outermost; } // Add elements passing elementMatchers directly to results // Support: IE<9, Safari // Tolerate NodeList properties (IE: "length"; Safari: ) matching elements by id - for ( ; i !== len && (elem = elems[i]) != null; i++ ) { + for ( ; i !== len && ( elem = elems[ i ] ) != null; i++ ) { if ( byElement && elem ) { j = 0; - if ( !context && elem.ownerDocument !== document ) { + + // Support: IE 11+, Edge 17 - 18+ + // IE/Edge sometimes throw a "Permission denied" error when strict-comparing + // two documents; shallow comparisons work. + // eslint-disable-next-line eqeqeq + if ( !context && elem.ownerDocument != document ) { setDocument( elem ); xml = !documentIsHTML; } - while ( (matcher = elementMatchers[j++]) ) { - if ( matcher( elem, context || document, xml) ) { + while ( ( matcher = elementMatchers[ j++ ] ) ) { + if ( matcher( elem, context || document, xml ) ) { results.push( elem ); break; } @@ -2546,8 +2719,9 @@ function matcherFromGroupMatchers( elementMatchers, setMatchers ) { // Track unmatched elements for set filters if ( bySet ) { + // They will have gone through all possible matchers - if ( (elem = !matcher && elem) ) { + if ( ( elem = !matcher && elem ) ) { matchedCount--; } @@ -2571,16 +2745,17 @@ function matcherFromGroupMatchers( elementMatchers, setMatchers ) { // numerically zero. if ( bySet && i !== matchedCount ) { j = 0; - while ( (matcher = setMatchers[j++]) ) { + while ( ( matcher = setMatchers[ j++ ] ) ) { matcher( unmatched, setMatched, context, xml ); } if ( seed ) { + // Reintegrate element matches to eliminate the need for sorting if ( matchedCount > 0 ) { while ( i-- ) { - if ( !(unmatched[i] || setMatched[i]) ) { - setMatched[i] = pop.call( results ); + if ( !( unmatched[ i ] || setMatched[ i ] ) ) { + setMatched[ i ] = pop.call( results ); } } } @@ -2621,13 +2796,14 @@ compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { cached = compilerCache[ selector + " " ]; if ( !cached ) { + // Generate a function of recursive functions that can be used to check each element if ( !match ) { match = tokenize( selector ); } i = match.length; while ( i-- ) { - cached = matcherFromTokens( match[i] ); + cached = matcherFromTokens( match[ i ] ); if ( cached[ expando ] ) { setMatchers.push( cached ); } else { @@ -2636,7 +2812,10 @@ compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { } // Cache the compiled function - cached = compilerCache( selector, matcherFromGroupMatchers( elementMatchers, setMatchers ) ); + cached = compilerCache( + selector, + matcherFromGroupMatchers( elementMatchers, setMatchers ) + ); // Save selector and tokenization cached.selector = selector; @@ -2656,7 +2835,7 @@ compile = Sizzle.compile = function( selector, match /* Internal Use Only */ ) { select = Sizzle.select = function( selector, context, results, seed ) { var i, tokens, token, type, find, compiled = typeof selector === "function" && selector, - match = !seed && tokenize( (selector = compiled.selector || selector) ); + match = !seed && tokenize( ( selector = compiled.selector || selector ) ); results = results || []; @@ -2665,11 +2844,12 @@ select = Sizzle.select = function( selector, context, results, seed ) { if ( match.length === 1 ) { // Reduce context if the leading compound selector is an ID - tokens = match[0] = match[0].slice( 0 ); - if ( tokens.length > 2 && (token = tokens[0]).type === "ID" && - context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[1].type ] ) { + tokens = match[ 0 ] = match[ 0 ].slice( 0 ); + if ( tokens.length > 2 && ( token = tokens[ 0 ] ).type === "ID" && + context.nodeType === 9 && documentIsHTML && Expr.relative[ tokens[ 1 ].type ] ) { - context = ( Expr.find["ID"]( token.matches[0].replace(runescape, funescape), context ) || [] )[0]; + context = ( Expr.find[ "ID" ]( token.matches[ 0 ] + .replace( runescape, funescape ), context ) || [] )[ 0 ]; if ( !context ) { return results; @@ -2682,20 +2862,22 @@ select = Sizzle.select = function( selector, context, results, seed ) { } // Fetch a seed set for right-to-left matching - i = matchExpr["needsContext"].test( selector ) ? 0 : tokens.length; + i = matchExpr[ "needsContext" ].test( selector ) ? 0 : tokens.length; while ( i-- ) { - token = tokens[i]; + token = tokens[ i ]; // Abort if we hit a combinator - if ( Expr.relative[ (type = token.type) ] ) { + if ( Expr.relative[ ( type = token.type ) ] ) { break; } - if ( (find = Expr.find[ type ]) ) { + if ( ( find = Expr.find[ type ] ) ) { + // Search, expanding context for leading sibling combinators - if ( (seed = find( - token.matches[0].replace( runescape, funescape ), - rsibling.test( tokens[0].type ) && testContext( context.parentNode ) || context - )) ) { + if ( ( seed = find( + token.matches[ 0 ].replace( runescape, funescape ), + rsibling.test( tokens[ 0 ].type ) && testContext( context.parentNode ) || + context + ) ) ) { // If seed is empty or no tokens remain, we can return early tokens.splice( i, 1 ); @@ -2726,7 +2908,7 @@ select = Sizzle.select = function( selector, context, results, seed ) { // One-time assignments // Sort stability -support.sortStable = expando.split("").sort( sortOrder ).join("") === expando; +support.sortStable = expando.split( "" ).sort( sortOrder ).join( "" ) === expando; // Support: Chrome 14-35+ // Always assume duplicates if they aren't passed to the comparison function @@ -2737,58 +2919,59 @@ setDocument(); // Support: Webkit<537.32 - Safari 6.0.3/Chrome 25 (fixed in Chrome 27) // Detached nodes confoundingly follow *each other* -support.sortDetached = assert(function( el ) { +support.sortDetached = assert( function( el ) { + // Should return 1, but returns 4 (following) - return el.compareDocumentPosition( document.createElement("fieldset") ) & 1; -}); + return el.compareDocumentPosition( document.createElement( "fieldset" ) ) & 1; +} ); // Support: IE<8 // Prevent attribute/property "interpolation" // https://msdn.microsoft.com/en-us/library/ms536429%28VS.85%29.aspx -if ( !assert(function( el ) { +if ( !assert( function( el ) { el.innerHTML = ""; - return el.firstChild.getAttribute("href") === "#" ; -}) ) { + return el.firstChild.getAttribute( "href" ) === "#"; +} ) ) { addHandle( "type|href|height|width", function( elem, name, isXML ) { if ( !isXML ) { return elem.getAttribute( name, name.toLowerCase() === "type" ? 1 : 2 ); } - }); + } ); } // Support: IE<9 // Use defaultValue in place of getAttribute("value") -if ( !support.attributes || !assert(function( el ) { +if ( !support.attributes || !assert( function( el ) { el.innerHTML = ""; el.firstChild.setAttribute( "value", "" ); return el.firstChild.getAttribute( "value" ) === ""; -}) ) { - addHandle( "value", function( elem, name, isXML ) { +} ) ) { + addHandle( "value", function( elem, _name, isXML ) { if ( !isXML && elem.nodeName.toLowerCase() === "input" ) { return elem.defaultValue; } - }); + } ); } // Support: IE<9 // Use getAttributeNode to fetch booleans when getAttribute lies -if ( !assert(function( el ) { - return el.getAttribute("disabled") == null; -}) ) { +if ( !assert( function( el ) { + return el.getAttribute( "disabled" ) == null; +} ) ) { addHandle( booleans, function( elem, name, isXML ) { var val; if ( !isXML ) { return elem[ name ] === true ? name.toLowerCase() : - (val = elem.getAttributeNode( name )) && val.specified ? + ( val = elem.getAttributeNode( name ) ) && val.specified ? val.value : - null; + null; } - }); + } ); } return Sizzle; -})( window ); +} )( window ); @@ -2848,11 +3031,9 @@ var rsingleTag = ( /^<([a-z][^\/\0>:\x20\t\r\n\f]*)[\x20\t\r\n\f]*\/?>(?:<\/\1>| -var risSimple = /^.[^:#\[\.,]*$/; - // Implement the identical functionality for filter and not function winnow( elements, qualifier, not ) { - if ( jQuery.isFunction( qualifier ) ) { + if ( isFunction( qualifier ) ) { return jQuery.grep( elements, function( elem, i ) { return !!qualifier.call( elem, i, elem ) !== not; } ); @@ -2872,16 +3053,8 @@ function winnow( elements, qualifier, not ) { } ); } - // Simple selector that can be filtered directly, removing non-Elements - if ( risSimple.test( qualifier ) ) { - return jQuery.filter( qualifier, elements, not ); - } - - // Complex selector, compare the two sets, removing non-Elements - qualifier = jQuery.filter( qualifier, elements ); - return jQuery.grep( elements, function( elem ) { - return ( indexOf.call( qualifier, elem ) > -1 ) !== not && elem.nodeType === 1; - } ); + // Filtered directly for both simple and complex selectors + return jQuery.filter( qualifier, elements, not ); } jQuery.filter = function( expr, elems, not ) { @@ -3002,7 +3175,7 @@ var rootjQuery, for ( match in context ) { // Properties of context are called as methods if possible - if ( jQuery.isFunction( this[ match ] ) ) { + if ( isFunction( this[ match ] ) ) { this[ match ]( context[ match ] ); // ...and otherwise set as attributes @@ -3045,7 +3218,7 @@ var rootjQuery, // HANDLE: $(function) // Shortcut for document ready - } else if ( jQuery.isFunction( selector ) ) { + } else if ( isFunction( selector ) ) { return root.ready !== undefined ? root.ready( selector ) : @@ -3167,7 +3340,7 @@ jQuery.each( { parents: function( elem ) { return dir( elem, "parentNode" ); }, - parentsUntil: function( elem, i, until ) { + parentsUntil: function( elem, _i, until ) { return dir( elem, "parentNode", until ); }, next: function( elem ) { @@ -3182,10 +3355,10 @@ jQuery.each( { prevAll: function( elem ) { return dir( elem, "previousSibling" ); }, - nextUntil: function( elem, i, until ) { + nextUntil: function( elem, _i, until ) { return dir( elem, "nextSibling", until ); }, - prevUntil: function( elem, i, until ) { + prevUntil: function( elem, _i, until ) { return dir( elem, "previousSibling", until ); }, siblings: function( elem ) { @@ -3195,18 +3368,24 @@ jQuery.each( { return siblings( elem.firstChild ); }, contents: function( elem ) { - if ( nodeName( elem, "iframe" ) ) { - return elem.contentDocument; - } + if ( elem.contentDocument != null && - // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only - // Treat the template element as a regular one in browsers that - // don't support it. - if ( nodeName( elem, "template" ) ) { - elem = elem.content || elem; - } + // Support: IE 11+ + // elements with no `data` attribute has an object + // `contentDocument` with a `null` prototype. + getProto( elem.contentDocument ) ) { - return jQuery.merge( [], elem.childNodes ); + return elem.contentDocument; + } + + // Support: IE 9 - 11 only, iOS 7 only, Android Browser <=4.3 only + // Treat the template element as a regular one in browsers that + // don't support it. + if ( nodeName( elem, "template" ) ) { + elem = elem.content || elem; + } + + return jQuery.merge( [], elem.childNodes ); } }, function( name, fn ) { jQuery.fn[ name ] = function( until, selector ) { @@ -3360,11 +3539,11 @@ jQuery.Callbacks = function( options ) { ( function add( args ) { jQuery.each( args, function( _, arg ) { - if ( jQuery.isFunction( arg ) ) { + if ( isFunction( arg ) ) { if ( !options.unique || !self.has( arg ) ) { list.push( arg ); } - } else if ( arg && arg.length && jQuery.type( arg ) !== "string" ) { + } else if ( arg && arg.length && toType( arg ) !== "string" ) { // Inspect recursively add( arg ); @@ -3479,11 +3658,11 @@ function adoptValue( value, resolve, reject, noValue ) { try { // Check for promise aspect first to privilege synchronous behavior - if ( value && jQuery.isFunction( ( method = value.promise ) ) ) { + if ( value && isFunction( ( method = value.promise ) ) ) { method.call( value ).done( resolve ).fail( reject ); // Other thenables - } else if ( value && jQuery.isFunction( ( method = value.then ) ) ) { + } else if ( value && isFunction( ( method = value.then ) ) ) { method.call( value, resolve, reject ); // Other non-thenables @@ -3538,17 +3717,17 @@ jQuery.extend( { var fns = arguments; return jQuery.Deferred( function( newDefer ) { - jQuery.each( tuples, function( i, tuple ) { + jQuery.each( tuples, function( _i, tuple ) { // Map tuples (progress, done, fail) to arguments (done, fail, progress) - var fn = jQuery.isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; + var fn = isFunction( fns[ tuple[ 4 ] ] ) && fns[ tuple[ 4 ] ]; // deferred.progress(function() { bind to newDefer or newDefer.notify }) // deferred.done(function() { bind to newDefer or newDefer.resolve }) // deferred.fail(function() { bind to newDefer or newDefer.reject }) deferred[ tuple[ 1 ] ]( function() { var returned = fn && fn.apply( this, arguments ); - if ( returned && jQuery.isFunction( returned.promise ) ) { + if ( returned && isFunction( returned.promise ) ) { returned.promise() .progress( newDefer.notify ) .done( newDefer.resolve ) @@ -3602,7 +3781,7 @@ jQuery.extend( { returned.then; // Handle a returned thenable - if ( jQuery.isFunction( then ) ) { + if ( isFunction( then ) ) { // Special processors (notify) just wait for resolution if ( special ) { @@ -3698,7 +3877,7 @@ jQuery.extend( { resolve( 0, newDefer, - jQuery.isFunction( onProgress ) ? + isFunction( onProgress ) ? onProgress : Identity, newDefer.notifyWith @@ -3710,7 +3889,7 @@ jQuery.extend( { resolve( 0, newDefer, - jQuery.isFunction( onFulfilled ) ? + isFunction( onFulfilled ) ? onFulfilled : Identity ) @@ -3721,7 +3900,7 @@ jQuery.extend( { resolve( 0, newDefer, - jQuery.isFunction( onRejected ) ? + isFunction( onRejected ) ? onRejected : Thrower ) @@ -3761,8 +3940,15 @@ jQuery.extend( { // fulfilled_callbacks.disable tuples[ 3 - i ][ 2 ].disable, + // rejected_handlers.disable + // fulfilled_handlers.disable + tuples[ 3 - i ][ 3 ].disable, + // progress_callbacks.lock - tuples[ 0 ][ 2 ].lock + tuples[ 0 ][ 2 ].lock, + + // progress_handlers.lock + tuples[ 0 ][ 3 ].lock ); } @@ -3832,7 +4018,7 @@ jQuery.extend( { // Use .then() to unwrap secondary thenables (cf. gh-3000) if ( master.state() === "pending" || - jQuery.isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { + isFunction( resolveValues[ i ] && resolveValues[ i ].then ) ) { return master.then(); } @@ -3960,7 +4146,7 @@ var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { bulk = key == null; // Sets many values - if ( jQuery.type( key ) === "object" ) { + if ( toType( key ) === "object" ) { chainable = true; for ( i in key ) { access( elems, fn, i, key[ i ], true, emptyGet, raw ); @@ -3970,7 +4156,7 @@ var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { } else if ( value !== undefined ) { chainable = true; - if ( !jQuery.isFunction( value ) ) { + if ( !isFunction( value ) ) { raw = true; } @@ -3984,7 +4170,7 @@ var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { // ...except when executing function values } else { bulk = fn; - fn = function( elem, key, value ) { + fn = function( elem, _key, value ) { return bulk.call( jQuery( elem ), value ); }; } @@ -4012,6 +4198,23 @@ var access = function( elems, fn, key, value, chainable, emptyGet, raw ) { return len ? fn( elems[ 0 ], key ) : emptyGet; }; + + +// Matches dashed string for camelizing +var rmsPrefix = /^-ms-/, + rdashAlpha = /-([a-z])/g; + +// Used by camelCase as callback to replace() +function fcamelCase( _all, letter ) { + return letter.toUpperCase(); +} + +// Convert dashed to camelCase; used by the css and data modules +// Support: IE <=9 - 11, Edge 12 - 15 +// Microsoft forgot to hump their vendor prefix (#9572) +function camelCase( string ) { + return string.replace( rmsPrefix, "ms-" ).replace( rdashAlpha, fcamelCase ); +} var acceptData = function( owner ) { // Accepts only: @@ -4074,14 +4277,14 @@ Data.prototype = { // Handle: [ owner, key, value ] args // Always use camelCase key (gh-2257) if ( typeof data === "string" ) { - cache[ jQuery.camelCase( data ) ] = value; + cache[ camelCase( data ) ] = value; // Handle: [ owner, { properties } ] args } else { // Copy the properties one-by-one to the cache object for ( prop in data ) { - cache[ jQuery.camelCase( prop ) ] = data[ prop ]; + cache[ camelCase( prop ) ] = data[ prop ]; } } return cache; @@ -4091,7 +4294,7 @@ Data.prototype = { this.cache( owner ) : // Always use camelCase key (gh-2257) - owner[ this.expando ] && owner[ this.expando ][ jQuery.camelCase( key ) ]; + owner[ this.expando ] && owner[ this.expando ][ camelCase( key ) ]; }, access: function( owner, key, value ) { @@ -4139,9 +4342,9 @@ Data.prototype = { // If key is an array of keys... // We always set camelCase keys, so remove that. - key = key.map( jQuery.camelCase ); + key = key.map( camelCase ); } else { - key = jQuery.camelCase( key ); + key = camelCase( key ); // If a key with the spaces exists, use it. // Otherwise, create an array by matching non-whitespace @@ -4287,7 +4490,7 @@ jQuery.fn.extend( { if ( attrs[ i ] ) { name = attrs[ i ].name; if ( name.indexOf( "data-" ) === 0 ) { - name = jQuery.camelCase( name.slice( 5 ) ); + name = camelCase( name.slice( 5 ) ); dataAttr( elem, name, data[ name ] ); } } @@ -4491,6 +4694,26 @@ var rcssNum = new RegExp( "^(?:([+-])=|)(" + pnum + ")([a-z%]*)$", "i" ); var cssExpand = [ "Top", "Right", "Bottom", "Left" ]; +var documentElement = document.documentElement; + + + + var isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ); + }, + composed = { composed: true }; + + // Support: IE 9 - 11+, Edge 12 - 18+, iOS 10.0 - 10.2 only + // Check attachment across shadow DOM boundaries when possible (gh-3504) + // Support: iOS 10.0-10.2 only + // Early iOS 10 versions support `attachShadow` but not `getRootNode`, + // leading to errors. We need to check for `getRootNode`. + if ( documentElement.getRootNode ) { + isAttached = function( elem ) { + return jQuery.contains( elem.ownerDocument, elem ) || + elem.getRootNode( composed ) === elem.ownerDocument; + }; + } var isHiddenWithinTree = function( elem, el ) { // isHiddenWithinTree might be called from jQuery#filter function; @@ -4505,37 +4728,15 @@ var isHiddenWithinTree = function( elem, el ) { // Support: Firefox <=43 - 45 // Disconnected elements can have computed display: none, so first confirm that elem is // in the document. - jQuery.contains( elem.ownerDocument, elem ) && + isAttached( elem ) && jQuery.css( elem, "display" ) === "none"; }; -var swap = function( elem, options, callback, args ) { - var ret, name, - old = {}; - - // Remember the old values, and insert the new ones - for ( name in options ) { - old[ name ] = elem.style[ name ]; - elem.style[ name ] = options[ name ]; - } - - ret = callback.apply( elem, args || [] ); - - // Revert the old values - for ( name in options ) { - elem.style[ name ] = old[ name ]; - } - - return ret; -}; - - function adjustCSS( elem, prop, valueParts, tween ) { - var adjusted, - scale = 1, + var adjusted, scale, maxIterations = 20, currentValue = tween ? function() { @@ -4548,35 +4749,39 @@ function adjustCSS( elem, prop, valueParts, tween ) { unit = valueParts && valueParts[ 3 ] || ( jQuery.cssNumber[ prop ] ? "" : "px" ), // Starting value computation is required for potential unit mismatches - initialInUnit = ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && + initialInUnit = elem.nodeType && + ( jQuery.cssNumber[ prop ] || unit !== "px" && +initial ) && rcssNum.exec( jQuery.css( elem, prop ) ); if ( initialInUnit && initialInUnit[ 3 ] !== unit ) { + // Support: Firefox <=54 + // Halve the iteration target value to prevent interference from CSS upper bounds (gh-2144) + initial = initial / 2; + // Trust units reported by jQuery.css unit = unit || initialInUnit[ 3 ]; - // Make sure we update the tween properties later on - valueParts = valueParts || []; - // Iteratively approximate from a nonzero starting point initialInUnit = +initial || 1; - do { - - // If previous iteration zeroed out, double until we get *something*. - // Use string for doubling so we don't accidentally see scale as unchanged below - scale = scale || ".5"; + while ( maxIterations-- ) { - // Adjust and apply - initialInUnit = initialInUnit / scale; + // Evaluate and update our best guess (doubling guesses that zero out). + // Finish if the scale equals or crosses 1 (making the old*new product non-positive). jQuery.style( elem, prop, initialInUnit + unit ); + if ( ( 1 - scale ) * ( 1 - ( scale = currentValue() / initial || 0.5 ) ) <= 0 ) { + maxIterations = 0; + } + initialInUnit = initialInUnit / scale; - // Update scale, tolerating zero or NaN from tween.cur() - // Break the loop if scale is unchanged or perfect, or if we've just had enough. - } while ( - scale !== ( scale = currentValue() / initial ) && scale !== 1 && --maxIterations - ); + } + + initialInUnit = initialInUnit * 2; + jQuery.style( elem, prop, initialInUnit + unit ); + + // Make sure we update the tween properties later on + valueParts = valueParts || []; } if ( valueParts ) { @@ -4692,17 +4897,46 @@ jQuery.fn.extend( { } ); var rcheckableType = ( /^(?:checkbox|radio)$/i ); -var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]+)/i ); +var rtagName = ( /<([a-z][^\/\0>\x20\t\r\n\f]*)/i ); -var rscriptType = ( /^$|\/(?:java|ecma)script/i ); +var rscriptType = ( /^$|^module$|\/(?:java|ecma)script/i ); -// We have to close these tags to support XHTML (#13200) -var wrapMap = { +( function() { + var fragment = document.createDocumentFragment(), + div = fragment.appendChild( document.createElement( "div" ) ), + input = document.createElement( "input" ); + + // Support: Android 4.0 - 4.3 only + // Check state lost if the name is set (#11217) + // Support: Windows Web Apps (WWA) + // `name` and `type` must use .setAttribute for WWA (#14901) + input.setAttribute( "type", "radio" ); + input.setAttribute( "checked", "checked" ); + input.setAttribute( "name", "t" ); + + div.appendChild( input ); + + // Support: Android <=4.1 only + // Older WebKit doesn't clone checked state correctly in fragments + support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; + + // Support: IE <=11 only + // Make sure textarea (and checkbox) defaultValue is properly cloned + div.innerHTML = ""; + support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; // Support: IE <=9 only - option: [ 1, "" ], + // IE <=9 replaces "; + support.option = !!div.lastChild; +} )(); + + +// We have to close these tags to support XHTML (#13200) +var wrapMap = { // XHTML parsers do not magically insert elements in the // same way that tag soup parsers do. So we cannot shorten @@ -4715,12 +4949,14 @@ var wrapMap = { _default: [ 0, "", "" ] }; -// Support: IE <=9 only -wrapMap.optgroup = wrapMap.option; - wrapMap.tbody = wrapMap.tfoot = wrapMap.colgroup = wrapMap.caption = wrapMap.thead; wrapMap.th = wrapMap.td; +// Support: IE <=9 only +if ( !support.option ) { + wrapMap.optgroup = wrapMap.option = [ 1, "" ]; +} + function getAll( context, tag ) { @@ -4764,7 +5000,7 @@ function setGlobalEval( elems, refElements ) { var rhtml = /<|&#?\w+;/; function buildFragment( elems, context, scripts, selection, ignored ) { - var elem, tmp, tag, wrap, contains, j, + var elem, tmp, tag, wrap, attached, j, fragment = context.createDocumentFragment(), nodes = [], i = 0, @@ -4776,7 +5012,7 @@ function buildFragment( elems, context, scripts, selection, ignored ) { if ( elem || elem === 0 ) { // Add nodes directly - if ( jQuery.type( elem ) === "object" ) { + if ( toType( elem ) === "object" ) { // Support: Android <=4.0 only, PhantomJS 1 only // push.apply(_, arraylike) throws on ancient WebKit @@ -4828,13 +5064,13 @@ function buildFragment( elems, context, scripts, selection, ignored ) { continue; } - contains = jQuery.contains( elem.ownerDocument, elem ); + attached = isAttached( elem ); // Append to fragment tmp = getAll( fragment.appendChild( elem ), "script" ); // Preserve script evaluation history - if ( contains ) { + if ( attached ) { setGlobalEval( tmp ); } @@ -4853,34 +5089,6 @@ function buildFragment( elems, context, scripts, selection, ignored ) { } -( function() { - var fragment = document.createDocumentFragment(), - div = fragment.appendChild( document.createElement( "div" ) ), - input = document.createElement( "input" ); - - // Support: Android 4.0 - 4.3 only - // Check state lost if the name is set (#11217) - // Support: Windows Web Apps (WWA) - // `name` and `type` must use .setAttribute for WWA (#14901) - input.setAttribute( "type", "radio" ); - input.setAttribute( "checked", "checked" ); - input.setAttribute( "name", "t" ); - - div.appendChild( input ); - - // Support: Android <=4.1 only - // Older WebKit doesn't clone checked state correctly in fragments - support.checkClone = div.cloneNode( true ).cloneNode( true ).lastChild.checked; - - // Support: IE <=11 only - // Make sure textarea (and checkbox) defaultValue is properly cloned - div.innerHTML = ""; - support.noCloneChecked = !!div.cloneNode( true ).lastChild.defaultValue; -} )(); -var documentElement = document.documentElement; - - - var rkeyEvent = /^key/, rmouseEvent = /^(?:mouse|pointer|contextmenu|drag|drop)|click/, @@ -4894,8 +5102,19 @@ function returnFalse() { return false; } +// Support: IE <=9 - 11+ +// focus() and blur() are asynchronous, except when they are no-op. +// So expect focus to be synchronous when the element is already active, +// and blur to be synchronous when the element is not already active. +// (focus and blur are always synchronous in other supported browsers, +// this just defines when we can count on it). +function expectSync( elem, type ) { + return ( elem === safeActiveElement() ) === ( type === "focus" ); +} + // Support: IE <=9 only -// See #13393 for more info +// Accessing document.activeElement can throw unexpectedly +// https://bugs.jquery.com/ticket/13393 function safeActiveElement() { try { return document.activeElement; @@ -4978,8 +5197,8 @@ jQuery.event = { special, handlers, type, namespaces, origType, elemData = dataPriv.get( elem ); - // Don't attach events to noData or text/comment nodes (but allow plain objects) - if ( !elemData ) { + // Only attach events to objects that accept data + if ( !acceptData( elem ) ) { return; } @@ -5003,7 +5222,7 @@ jQuery.event = { // Init the element's event structure and main handler, if this is the first if ( !( events = elemData.events ) ) { - events = elemData.events = {}; + events = elemData.events = Object.create( null ); } if ( !( eventHandle = elemData.handle ) ) { eventHandle = elemData.handle = function( e ) { @@ -5161,12 +5380,15 @@ jQuery.event = { dispatch: function( nativeEvent ) { - // Make a writable jQuery.Event from the native event object - var event = jQuery.event.fix( nativeEvent ); - var i, j, ret, matched, handleObj, handlerQueue, args = new Array( arguments.length ), - handlers = ( dataPriv.get( this, "events" ) || {} )[ event.type ] || [], + + // Make a writable jQuery.Event from the native event object + event = jQuery.event.fix( nativeEvent ), + + handlers = ( + dataPriv.get( this, "events" ) || Object.create( null ) + )[ event.type ] || [], special = jQuery.event.special[ event.type ] || {}; // Use the fix-ed jQuery.Event rather than the (read-only) native event @@ -5195,9 +5417,10 @@ jQuery.event = { while ( ( handleObj = matched.handlers[ j++ ] ) && !event.isImmediatePropagationStopped() ) { - // Triggered event must either 1) have no namespace, or 2) have namespace(s) - // a subset or equal to those in the bound event (both can have no namespace). - if ( !event.rnamespace || event.rnamespace.test( handleObj.namespace ) ) { + // If the event is namespaced, then each handler is only invoked if it is + // specially universal or its namespaces are a superset of the event's. + if ( !event.rnamespace || handleObj.namespace === false || + event.rnamespace.test( handleObj.namespace ) ) { event.handleObj = handleObj; event.data = handleObj.data; @@ -5286,7 +5509,7 @@ jQuery.event = { enumerable: true, configurable: true, - get: jQuery.isFunction( hook ) ? + get: isFunction( hook ) ? function() { if ( this.originalEvent ) { return hook( this.originalEvent ); @@ -5321,39 +5544,51 @@ jQuery.event = { // Prevent triggered image.load events from bubbling to window.load noBubble: true }, - focus: { + click: { - // Fire native event if possible so blur/focus sequence is correct - trigger: function() { - if ( this !== safeActiveElement() && this.focus ) { - this.focus(); - return false; - } - }, - delegateType: "focusin" - }, - blur: { - trigger: function() { - if ( this === safeActiveElement() && this.blur ) { - this.blur(); - return false; + // Utilize native event to ensure correct state for checkable inputs + setup: function( data ) { + + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Claim the first handler + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + // dataPriv.set( el, "click", ... ) + leverageNative( el, "click", returnTrue ); } + + // Return false to allow normal processing in the caller + return false; }, - delegateType: "focusout" - }, - click: { + trigger: function( data ) { - // For checkbox, fire native event so checked state will be right - trigger: function() { - if ( this.type === "checkbox" && this.click && nodeName( this, "input" ) ) { - this.click(); - return false; + // For mutual compressibility with _default, replace `this` access with a local var. + // `|| data` is dead code meant only to preserve the variable through minification. + var el = this || data; + + // Force setup before triggering a click + if ( rcheckableType.test( el.type ) && + el.click && nodeName( el, "input" ) ) { + + leverageNative( el, "click" ); } + + // Return non-false to allow normal event-path propagation + return true; }, - // For cross-browser consistency, don't fire native .click() on links + // For cross-browser consistency, suppress native .click() on links + // Also prevent it if we're currently inside a leveraged native-event stack _default: function( event ) { - return nodeName( event.target, "a" ); + var target = event.target; + return rcheckableType.test( target.type ) && + target.click && nodeName( target, "input" ) && + dataPriv.get( target, "click" ) || + nodeName( target, "a" ); } }, @@ -5367,8 +5602,95 @@ jQuery.event = { } } } - } -}; + } +}; + +// Ensure the presence of an event listener that handles manually-triggered +// synthetic events by interrupting progress until reinvoked in response to +// *native* events that it fires directly, ensuring that state changes have +// already occurred before other listeners are invoked. +function leverageNative( el, type, expectSync ) { + + // Missing expectSync indicates a trigger call, which must force setup through jQuery.event.add + if ( !expectSync ) { + if ( dataPriv.get( el, type ) === undefined ) { + jQuery.event.add( el, type, returnTrue ); + } + return; + } + + // Register the controller as a special universal handler for all event namespaces + dataPriv.set( el, type, false ); + jQuery.event.add( el, type, { + namespace: false, + handler: function( event ) { + var notAsync, result, + saved = dataPriv.get( this, type ); + + if ( ( event.isTrigger & 1 ) && this[ type ] ) { + + // Interrupt processing of the outer synthetic .trigger()ed event + // Saved data should be false in such cases, but might be a leftover capture object + // from an async native handler (gh-4350) + if ( !saved.length ) { + + // Store arguments for use when handling the inner native event + // There will always be at least one argument (an event object), so this array + // will not be confused with a leftover capture object. + saved = slice.call( arguments ); + dataPriv.set( this, type, saved ); + + // Trigger the native event and capture its result + // Support: IE <=9 - 11+ + // focus() and blur() are asynchronous + notAsync = expectSync( this, type ); + this[ type ](); + result = dataPriv.get( this, type ); + if ( saved !== result || notAsync ) { + dataPriv.set( this, type, false ); + } else { + result = {}; + } + if ( saved !== result ) { + + // Cancel the outer synthetic event + event.stopImmediatePropagation(); + event.preventDefault(); + return result.value; + } + + // If this is an inner synthetic event for an event with a bubbling surrogate + // (focus or blur), assume that the surrogate already propagated from triggering the + // native event and prevent that from happening again here. + // This technically gets the ordering wrong w.r.t. to `.trigger()` (in which the + // bubbling surrogate propagates *after* the non-bubbling base), but that seems + // less bad than duplication. + } else if ( ( jQuery.event.special[ type ] || {} ).delegateType ) { + event.stopPropagation(); + } + + // If this is a native event triggered above, everything is now in order + // Fire an inner synthetic event with the original arguments + } else if ( saved.length ) { + + // ...and capture the result + dataPriv.set( this, type, { + value: jQuery.event.trigger( + + // Support: IE <=9 - 11+ + // Extend with the prototype to reset the above stopImmediatePropagation() + jQuery.extend( saved[ 0 ], jQuery.Event.prototype ), + saved.slice( 1 ), + this + ) + } ); + + // Abort handling of the native event + event.stopImmediatePropagation(); + } + } + } ); +} jQuery.removeEvent = function( elem, type, handle ) { @@ -5421,7 +5743,7 @@ jQuery.Event = function( src, props ) { } // Create a timestamp if incoming event doesn't have one - this.timeStamp = src && src.timeStamp || jQuery.now(); + this.timeStamp = src && src.timeStamp || Date.now(); // Mark it as fixed this[ jQuery.expando ] = true; @@ -5482,6 +5804,7 @@ jQuery.each( { shiftKey: true, view: true, "char": true, + code: true, charCode: true, key: true, keyCode: true, @@ -5528,6 +5851,33 @@ jQuery.each( { } }, jQuery.event.addProp ); +jQuery.each( { focus: "focusin", blur: "focusout" }, function( type, delegateType ) { + jQuery.event.special[ type ] = { + + // Utilize native event if possible so blur/focus sequence is correct + setup: function() { + + // Claim the first handler + // dataPriv.set( this, "focus", ... ) + // dataPriv.set( this, "blur", ... ) + leverageNative( this, type, expectSync ); + + // Return false to allow normal processing in the caller + return false; + }, + trigger: function() { + + // Force setup before trigger + leverageNative( this, type ); + + // Return non-false to allow normal event-path propagation + return true; + }, + + delegateType: delegateType + }; +} ); + // Create mouseenter/leave events using mouseover/out and event-time checks // so that event delegation works in jQuery. // Do the same for pointerenter/pointerleave and pointerover/pointerout @@ -5613,21 +5963,13 @@ jQuery.fn.extend( { var - /* eslint-disable max-len */ - - // See https://github.com/eslint/eslint/issues/3229 - rxhtmlTag = /<(?!area|br|col|embed|hr|img|input|link|meta|param)(([a-z][^\/\0>\x20\t\r\n\f]*)[^>]*)\/>/gi, - - /* eslint-enable */ - - // Support: IE <=10 - 11, Edge 12 - 13 + // Support: IE <=10 - 11, Edge 12 - 13 only // In IE/Edge using regex groups here causes severe slowdowns. // See https://connect.microsoft.com/IE/feedback/details/1736512/ rnoInnerhtml = /\s*$/g; // Prefer a tbody over its parent table for containing new rows @@ -5635,7 +5977,7 @@ function manipulationTarget( elem, content ) { if ( nodeName( elem, "table" ) && nodeName( content.nodeType !== 11 ? content : content.firstChild, "tr" ) ) { - return jQuery( ">tbody", elem )[ 0 ] || elem; + return jQuery( elem ).children( "tbody" )[ 0 ] || elem; } return elem; @@ -5647,10 +5989,8 @@ function disableScript( elem ) { return elem; } function restoreScript( elem ) { - var match = rscriptTypeMasked.exec( elem.type ); - - if ( match ) { - elem.type = match[ 1 ]; + if ( ( elem.type || "" ).slice( 0, 5 ) === "true/" ) { + elem.type = elem.type.slice( 5 ); } else { elem.removeAttribute( "type" ); } @@ -5659,7 +5999,7 @@ function restoreScript( elem ) { } function cloneCopyEvent( src, dest ) { - var i, l, type, pdataOld, pdataCur, udataOld, udataCur, events; + var i, l, type, pdataOld, udataOld, udataCur, events; if ( dest.nodeType !== 1 ) { return; @@ -5667,13 +6007,11 @@ function cloneCopyEvent( src, dest ) { // 1. Copy private data: events, handlers, etc. if ( dataPriv.hasData( src ) ) { - pdataOld = dataPriv.access( src ); - pdataCur = dataPriv.set( dest, pdataOld ); + pdataOld = dataPriv.get( src ); events = pdataOld.events; if ( events ) { - delete pdataCur.handle; - pdataCur.events = {}; + dataPriv.remove( dest, "handle events" ); for ( type in events ) { for ( i = 0, l = events[ type ].length; i < l; i++ ) { @@ -5709,22 +6047,22 @@ function fixInput( src, dest ) { function domManip( collection, args, callback, ignored ) { // Flatten any nested arrays - args = concat.apply( [], args ); + args = flat( args ); var fragment, first, scripts, hasScripts, node, doc, i = 0, l = collection.length, iNoClone = l - 1, value = args[ 0 ], - isFunction = jQuery.isFunction( value ); + valueIsFunction = isFunction( value ); // We can't cloneNode fragments that contain checked, in WebKit - if ( isFunction || + if ( valueIsFunction || ( l > 1 && typeof value === "string" && !support.checkClone && rchecked.test( value ) ) ) { return collection.each( function( index ) { var self = collection.eq( index ); - if ( isFunction ) { + if ( valueIsFunction ) { args[ 0 ] = value.call( this, index, self.html() ); } domManip( self, args, callback, ignored ); @@ -5778,14 +6116,16 @@ function domManip( collection, args, callback, ignored ) { !dataPriv.access( node, "globalEval" ) && jQuery.contains( doc, node ) ) { - if ( node.src ) { + if ( node.src && ( node.type || "" ).toLowerCase() !== "module" ) { // Optional AJAX dependency, but won't run scripts if not present - if ( jQuery._evalUrl ) { - jQuery._evalUrl( node.src ); + if ( jQuery._evalUrl && !node.noModule ) { + jQuery._evalUrl( node.src, { + nonce: node.nonce || node.getAttribute( "nonce" ) + }, doc ); } } else { - DOMEval( node.textContent.replace( rcleanScript, "" ), doc ); + DOMEval( node.textContent.replace( rcleanScript, "" ), node, doc ); } } } @@ -5807,7 +6147,7 @@ function remove( elem, selector, keepData ) { } if ( node.parentNode ) { - if ( keepData && jQuery.contains( node.ownerDocument, node ) ) { + if ( keepData && isAttached( node ) ) { setGlobalEval( getAll( node, "script" ) ); } node.parentNode.removeChild( node ); @@ -5819,13 +6159,13 @@ function remove( elem, selector, keepData ) { jQuery.extend( { htmlPrefilter: function( html ) { - return html.replace( rxhtmlTag, "<$1>" ); + return html; }, clone: function( elem, dataAndEvents, deepDataAndEvents ) { var i, l, srcElements, destElements, clone = elem.cloneNode( true ), - inPage = jQuery.contains( elem.ownerDocument, elem ); + inPage = isAttached( elem ); // Fix IE cloning issues if ( !support.noCloneChecked && ( elem.nodeType === 1 || elem.nodeType === 11 ) && @@ -6065,8 +6405,6 @@ jQuery.each( { return this.pushStack( ret ); }; } ); -var rmargin = ( /^margin/ ); - var rnumnonpx = new RegExp( "^(" + pnum + ")(?!px)[a-z%]+$", "i" ); var getStyles = function( elem ) { @@ -6083,6 +6421,29 @@ var getStyles = function( elem ) { return view.getComputedStyle( elem ); }; +var swap = function( elem, options, callback ) { + var ret, name, + old = {}; + + // Remember the old values, and insert the new ones + for ( name in options ) { + old[ name ] = elem.style[ name ]; + elem.style[ name ] = options[ name ]; + } + + ret = callback.call( elem ); + + // Revert the old values + for ( name in options ) { + elem.style[ name ] = old[ name ]; + } + + return ret; +}; + + +var rboxStyle = new RegExp( cssExpand.join( "|" ), "i" ); + ( function() { @@ -6096,25 +6457,35 @@ var getStyles = function( elem ) { return; } + container.style.cssText = "position:absolute;left:-11111px;width:60px;" + + "margin-top:1px;padding:0;border:0"; div.style.cssText = - "box-sizing:border-box;" + - "position:relative;display:block;" + + "position:relative;display:block;box-sizing:border-box;overflow:scroll;" + "margin:auto;border:1px;padding:1px;" + - "top:1%;width:50%"; - div.innerHTML = ""; - documentElement.appendChild( container ); + "width:60%;top:1%"; + documentElement.appendChild( container ).appendChild( div ); var divStyle = window.getComputedStyle( div ); pixelPositionVal = divStyle.top !== "1%"; // Support: Android 4.0 - 4.3 only, Firefox <=3 - 44 - reliableMarginLeftVal = divStyle.marginLeft === "2px"; - boxSizingReliableVal = divStyle.width === "4px"; + reliableMarginLeftVal = roundPixelMeasures( divStyle.marginLeft ) === 12; - // Support: Android 4.0 - 4.3 only + // Support: Android 4.0 - 4.3 only, Safari <=9.1 - 10.1, iOS <=7.0 - 9.3 // Some styles come back with percentage values, even though they shouldn't - div.style.marginRight = "50%"; - pixelMarginRightVal = divStyle.marginRight === "4px"; + div.style.right = "60%"; + pixelBoxStylesVal = roundPixelMeasures( divStyle.right ) === 36; + + // Support: IE 9 - 11 only + // Detect misreporting of content dimensions for box-sizing:border-box elements + boxSizingReliableVal = roundPixelMeasures( divStyle.width ) === 36; + + // Support: IE 9 only + // Detect overflow:scroll screwiness (gh-3699) + // Support: Chrome <=64 + // Don't get tricked when zoom affects offsetWidth (gh-4029) + div.style.position = "absolute"; + scrollboxSizeVal = roundPixelMeasures( div.offsetWidth / 3 ) === 12; documentElement.removeChild( container ); @@ -6123,7 +6494,12 @@ var getStyles = function( elem ) { div = null; } - var pixelPositionVal, boxSizingReliableVal, pixelMarginRightVal, reliableMarginLeftVal, + function roundPixelMeasures( measure ) { + return Math.round( parseFloat( measure ) ); + } + + var pixelPositionVal, boxSizingReliableVal, scrollboxSizeVal, pixelBoxStylesVal, + reliableTrDimensionsVal, reliableMarginLeftVal, container = document.createElement( "div" ), div = document.createElement( "div" ); @@ -6138,26 +6514,55 @@ var getStyles = function( elem ) { div.cloneNode( true ).style.backgroundClip = ""; support.clearCloneStyle = div.style.backgroundClip === "content-box"; - container.style.cssText = "border:0;width:8px;height:0;top:0;left:-9999px;" + - "padding:0;margin-top:1px;position:absolute"; - container.appendChild( div ); - jQuery.extend( support, { - pixelPosition: function() { - computeStyleTests(); - return pixelPositionVal; - }, boxSizingReliable: function() { computeStyleTests(); return boxSizingReliableVal; }, - pixelMarginRight: function() { + pixelBoxStyles: function() { computeStyleTests(); - return pixelMarginRightVal; + return pixelBoxStylesVal; + }, + pixelPosition: function() { + computeStyleTests(); + return pixelPositionVal; }, reliableMarginLeft: function() { computeStyleTests(); return reliableMarginLeftVal; + }, + scrollboxSize: function() { + computeStyleTests(); + return scrollboxSizeVal; + }, + + // Support: IE 9 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Behavior in IE 9 is more subtle than in newer versions & it passes + // some versions of this test; make sure not to make it pass there! + reliableTrDimensions: function() { + var table, tr, trChild, trStyle; + if ( reliableTrDimensionsVal == null ) { + table = document.createElement( "table" ); + tr = document.createElement( "tr" ); + trChild = document.createElement( "div" ); + + table.style.cssText = "position:absolute;left:-11111px"; + tr.style.height = "1px"; + trChild.style.height = "9px"; + + documentElement + .appendChild( table ) + .appendChild( tr ) + .appendChild( trChild ); + + trStyle = window.getComputedStyle( tr ); + reliableTrDimensionsVal = parseInt( trStyle.height ) > 3; + + documentElement.removeChild( table ); + } + return reliableTrDimensionsVal; } } ); } )(); @@ -6180,7 +6585,7 @@ function curCSS( elem, name, computed ) { if ( computed ) { ret = computed.getPropertyValue( name ) || computed[ name ]; - if ( ret === "" && !jQuery.contains( elem.ownerDocument, elem ) ) { + if ( ret === "" && !isAttached( elem ) ) { ret = jQuery.style( elem, name ); } @@ -6189,7 +6594,7 @@ function curCSS( elem, name, computed ) { // but width seems to be reliably pixels. // This is against the CSSOM draft spec: // https://drafts.csswg.org/cssom/#resolved-values - if ( !support.pixelMarginRight() && rnumnonpx.test( ret ) && rmargin.test( name ) ) { + if ( !support.pixelBoxStyles() && rnumnonpx.test( ret ) && rboxStyle.test( name ) ) { // Remember the original values width = style.width; @@ -6236,30 +6641,13 @@ function addGetHookIf( conditionFn, hookFn ) { } -var - - // Swappable if display is none or starts with table - // except "table", "table-cell", or "table-caption" - // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display - rdisplayswap = /^(none|table(?!-c[ea]).+)/, - rcustomProp = /^--/, - cssShow = { position: "absolute", visibility: "hidden", display: "block" }, - cssNormalTransform = { - letterSpacing: "0", - fontWeight: "400" - }, - - cssPrefixes = [ "Webkit", "Moz", "ms" ], - emptyStyle = document.createElement( "div" ).style; +var cssPrefixes = [ "Webkit", "Moz", "ms" ], + emptyStyle = document.createElement( "div" ).style, + vendorProps = {}; -// Return a css property mapped to a potentially vendor prefixed property +// Return a vendor-prefixed property or undefined function vendorPropName( name ) { - // Shortcut for names that are not vendor prefixed - if ( name in emptyStyle ) { - return name; - } - // Check for vendor prefixed names var capName = name[ 0 ].toUpperCase() + name.slice( 1 ), i = cssPrefixes.length; @@ -6272,17 +6660,34 @@ function vendorPropName( name ) { } } -// Return a property mapped along what jQuery.cssProps suggests or to -// a vendor prefixed property. +// Return a potentially-mapped jQuery.cssProps or vendor prefixed property function finalPropName( name ) { - var ret = jQuery.cssProps[ name ]; - if ( !ret ) { - ret = jQuery.cssProps[ name ] = vendorPropName( name ) || name; + var final = jQuery.cssProps[ name ] || vendorProps[ name ]; + + if ( final ) { + return final; } - return ret; + if ( name in emptyStyle ) { + return name; + } + return vendorProps[ name ] = vendorPropName( name ) || name; } -function setPositiveNumber( elem, value, subtract ) { + +var + + // Swappable if display is none or starts with table + // except "table", "table-cell", or "table-caption" + // See here for display values: https://developer.mozilla.org/en-US/docs/CSS/display + rdisplayswap = /^(none|table(?!-c[ea]).+)/, + rcustomProp = /^--/, + cssShow = { position: "absolute", visibility: "hidden", display: "block" }, + cssNormalTransform = { + letterSpacing: "0", + fontWeight: "400" + }; + +function setPositiveNumber( _elem, value, subtract ) { // Any relative (+/-) values have already been // normalized at this point @@ -6294,87 +6699,146 @@ function setPositiveNumber( elem, value, subtract ) { value; } -function augmentWidthOrHeight( elem, name, extra, isBorderBox, styles ) { - var i, - val = 0; - - // If we already have the right measurement, avoid augmentation - if ( extra === ( isBorderBox ? "border" : "content" ) ) { - i = 4; +function boxModelAdjustment( elem, dimension, box, isBorderBox, styles, computedVal ) { + var i = dimension === "width" ? 1 : 0, + extra = 0, + delta = 0; - // Otherwise initialize for horizontal or vertical properties - } else { - i = name === "width" ? 1 : 0; + // Adjustment may not be necessary + if ( box === ( isBorderBox ? "border" : "content" ) ) { + return 0; } for ( ; i < 4; i += 2 ) { - // Both box models exclude margin, so add it if we want it - if ( extra === "margin" ) { - val += jQuery.css( elem, extra + cssExpand[ i ], true, styles ); + // Both box models exclude margin + if ( box === "margin" ) { + delta += jQuery.css( elem, box + cssExpand[ i ], true, styles ); } - if ( isBorderBox ) { + // If we get here with a content-box, we're seeking "padding" or "border" or "margin" + if ( !isBorderBox ) { - // border-box includes padding, so remove it if we want content - if ( extra === "content" ) { - val -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - } + // Add padding + delta += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); - // At this point, extra isn't border nor margin, so remove border - if ( extra !== "margin" ) { - val -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + // For "border" or "margin", add border + if ( box !== "padding" ) { + delta += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + + // But still keep track of it otherwise + } else { + extra += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); } + + // If we get here with a border-box (content + padding + border), we're seeking "content" or + // "padding" or "margin" } else { - // At this point, extra isn't content, so add padding - val += jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + // For "content", subtract padding + if ( box === "content" ) { + delta -= jQuery.css( elem, "padding" + cssExpand[ i ], true, styles ); + } - // At this point, extra isn't content nor padding, so add border - if ( extra !== "padding" ) { - val += jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); + // For "content" or "padding", subtract border + if ( box !== "margin" ) { + delta -= jQuery.css( elem, "border" + cssExpand[ i ] + "Width", true, styles ); } } } - return val; + // Account for positive content-box scroll gutter when requested by providing computedVal + if ( !isBorderBox && computedVal >= 0 ) { + + // offsetWidth/offsetHeight is a rounded sum of content, padding, scroll gutter, and border + // Assuming integer scroll gutter, subtract the rest and round down + delta += Math.max( 0, Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + computedVal - + delta - + extra - + 0.5 + + // If offsetWidth/offsetHeight is unknown, then we can't determine content-box scroll gutter + // Use an explicit zero to avoid NaN (gh-3964) + ) ) || 0; + } + + return delta; } -function getWidthOrHeight( elem, name, extra ) { +function getWidthOrHeight( elem, dimension, extra ) { // Start with computed style - var valueIsBorderBox, - styles = getStyles( elem ), - val = curCSS( elem, name, styles ), - isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + var styles = getStyles( elem ), + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-4322). + // Fake content-box until we know it's needed to know the true value. + boxSizingNeeded = !support.boxSizingReliable() || extra, + isBorderBox = boxSizingNeeded && + jQuery.css( elem, "boxSizing", false, styles ) === "border-box", + valueIsBorderBox = isBorderBox, - // Computed unit is not pixels. Stop here and return. + val = curCSS( elem, dimension, styles ), + offsetProp = "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ); + + // Support: Firefox <=54 + // Return a confounding non-pixel value or feign ignorance, as appropriate. if ( rnumnonpx.test( val ) ) { - return val; + if ( !extra ) { + return val; + } + val = "auto"; } - // Check for style in case a browser which returns unreliable values - // for getComputedStyle silently falls back to the reliable elem.style - valueIsBorderBox = isBorderBox && - ( support.boxSizingReliable() || val === elem.style[ name ] ); - // Fall back to offsetWidth/Height when value is "auto" - // This happens for inline elements with no explicit setting (gh-3571) - if ( val === "auto" ) { - val = elem[ "offset" + name[ 0 ].toUpperCase() + name.slice( 1 ) ]; + // Support: IE 9 - 11 only + // Use offsetWidth/offsetHeight for when box sizing is unreliable. + // In those cases, the computed value can be trusted to be border-box. + if ( ( !support.boxSizingReliable() && isBorderBox || + + // Support: IE 10 - 11+, Edge 15 - 18+ + // IE/Edge misreport `getComputedStyle` of table rows with width/height + // set in CSS while `offset*` properties report correct values. + // Interestingly, in some cases IE 9 doesn't suffer from this issue. + !support.reliableTrDimensions() && nodeName( elem, "tr" ) || + + // Fall back to offsetWidth/offsetHeight when value is "auto" + // This happens for inline elements with no explicit setting (gh-3571) + val === "auto" || + + // Support: Android <=4.1 - 4.3 only + // Also use offsetWidth/offsetHeight for misreported inline dimensions (gh-3602) + !parseFloat( val ) && jQuery.css( elem, "display", false, styles ) === "inline" ) && + + // Make sure the element is visible & connected + elem.getClientRects().length ) { + + isBorderBox = jQuery.css( elem, "boxSizing", false, styles ) === "border-box"; + + // Where available, offsetWidth/offsetHeight approximate border box dimensions. + // Where not available (e.g., SVG), assume unreliable box-sizing and interpret the + // retrieved value as a content box dimension. + valueIsBorderBox = offsetProp in elem; + if ( valueIsBorderBox ) { + val = elem[ offsetProp ]; + } } - // Normalize "", auto, and prepare for extra + // Normalize "" and auto val = parseFloat( val ) || 0; - // Use the active box-sizing model to add/subtract irrelevant styles + // Adjust for the element's box model return ( val + - augmentWidthOrHeight( + boxModelAdjustment( elem, - name, + dimension, extra || ( isBorderBox ? "border" : "content" ), valueIsBorderBox, - styles + styles, + + // Provide the current computed size to request scroll gutter calculation (gh-3589) + val ) ) + "px"; } @@ -6404,6 +6868,13 @@ jQuery.extend( { "flexGrow": true, "flexShrink": true, "fontWeight": true, + "gridArea": true, + "gridColumn": true, + "gridColumnEnd": true, + "gridColumnStart": true, + "gridRow": true, + "gridRowEnd": true, + "gridRowStart": true, "lineHeight": true, "opacity": true, "order": true, @@ -6415,9 +6886,7 @@ jQuery.extend( { // Add in properties whose names you wish to fix before // setting or getting the value - cssProps: { - "float": "cssFloat" - }, + cssProps: {}, // Get and set the style property on a DOM Node style: function( elem, name, value, extra ) { @@ -6429,7 +6898,7 @@ jQuery.extend( { // Make sure that we're working with the right name var ret, type, hooks, - origName = jQuery.camelCase( name ), + origName = camelCase( name ), isCustomProp = rcustomProp.test( name ), style = elem.style; @@ -6461,7 +6930,9 @@ jQuery.extend( { } // If a number was passed in, add the unit (except for certain CSS properties) - if ( type === "number" ) { + // The isCustomProp check can be removed in jQuery 4.0 when we only auto-append + // "px" to a few hardcoded values. + if ( type === "number" && !isCustomProp ) { value += ret && ret[ 3 ] || ( jQuery.cssNumber[ origName ] ? "" : "px" ); } @@ -6497,7 +6968,7 @@ jQuery.extend( { css: function( elem, name, extra, styles ) { var val, num, hooks, - origName = jQuery.camelCase( name ), + origName = camelCase( name ), isCustomProp = rcustomProp.test( name ); // Make sure that we're working with the right name. We don't @@ -6535,8 +7006,8 @@ jQuery.extend( { } } ); -jQuery.each( [ "height", "width" ], function( i, name ) { - jQuery.cssHooks[ name ] = { +jQuery.each( [ "height", "width" ], function( _i, dimension ) { + jQuery.cssHooks[ dimension ] = { get: function( elem, computed, extra ) { if ( computed ) { @@ -6552,29 +7023,52 @@ jQuery.each( [ "height", "width" ], function( i, name ) { // in IE throws an error. ( !elem.getClientRects().length || !elem.getBoundingClientRect().width ) ? swap( elem, cssShow, function() { - return getWidthOrHeight( elem, name, extra ); + return getWidthOrHeight( elem, dimension, extra ); } ) : - getWidthOrHeight( elem, name, extra ); + getWidthOrHeight( elem, dimension, extra ); } }, set: function( elem, value, extra ) { var matches, - styles = extra && getStyles( elem ), - subtract = extra && augmentWidthOrHeight( - elem, - name, - extra, + styles = getStyles( elem ), + + // Only read styles.position if the test has a chance to fail + // to avoid forcing a reflow. + scrollboxSizeBuggy = !support.scrollboxSize() && + styles.position === "absolute", + + // To avoid forcing a reflow, only fetch boxSizing if we need it (gh-3991) + boxSizingNeeded = scrollboxSizeBuggy || extra, + isBorderBox = boxSizingNeeded && jQuery.css( elem, "boxSizing", false, styles ) === "border-box", - styles + subtract = extra ? + boxModelAdjustment( + elem, + dimension, + extra, + isBorderBox, + styles + ) : + 0; + + // Account for unreliable border-box dimensions by comparing offset* to computed and + // faking a content-box to get border and padding (gh-3699) + if ( isBorderBox && scrollboxSizeBuggy ) { + subtract -= Math.ceil( + elem[ "offset" + dimension[ 0 ].toUpperCase() + dimension.slice( 1 ) ] - + parseFloat( styles[ dimension ] ) - + boxModelAdjustment( elem, dimension, "border", false, styles ) - + 0.5 ); + } // Convert to pixels if value adjustment is needed if ( subtract && ( matches = rcssNum.exec( value ) ) && ( matches[ 3 ] || "px" ) !== "px" ) { - elem.style[ name ] = value; - value = jQuery.css( elem, name ); + elem.style[ dimension ] = value; + value = jQuery.css( elem, dimension ); } return setPositiveNumber( elem, value, subtract ); @@ -6618,7 +7112,7 @@ jQuery.each( { } }; - if ( !rmargin.test( prefix ) ) { + if ( prefix !== "margin" ) { jQuery.cssHooks[ prefix + suffix ].set = setPositiveNumber; } } ); @@ -6728,9 +7222,9 @@ Tween.propHooks = { // Use .style if available and use plain properties where available. if ( jQuery.fx.step[ tween.prop ] ) { jQuery.fx.step[ tween.prop ]( tween ); - } else if ( tween.elem.nodeType === 1 && - ( tween.elem.style[ jQuery.cssProps[ tween.prop ] ] != null || - jQuery.cssHooks[ tween.prop ] ) ) { + } else if ( tween.elem.nodeType === 1 && ( + jQuery.cssHooks[ tween.prop ] || + tween.elem.style[ finalPropName( tween.prop ) ] != null ) ) { jQuery.style( tween.elem, tween.prop, tween.now + tween.unit ); } else { tween.elem[ tween.prop ] = tween.now; @@ -6789,7 +7283,7 @@ function createFxNow() { window.setTimeout( function() { fxNow = undefined; } ); - return ( fxNow = jQuery.now() ); + return ( fxNow = Date.now() ); } // Generate parameters to create a standard animation @@ -6893,9 +7387,10 @@ function defaultPrefilter( elem, props, opts ) { // Restrict "overflow" and "display" styles during box animations if ( isBox && elem.nodeType === 1 ) { - // Support: IE <=9 - 11, Edge 12 - 13 + // Support: IE <=9 - 11, Edge 12 - 15 // Record all 3 overflow attributes because IE does not infer the shorthand - // from identically-valued overflowX and overflowY + // from identically-valued overflowX and overflowY and Edge just mirrors + // the overflowX value there. opts.overflow = [ style.overflow, style.overflowX, style.overflowY ]; // Identify a display type, preferring old show/hide data over the CSS cascade @@ -7003,7 +7498,7 @@ function propFilter( props, specialEasing ) { // camelCase, specialEasing and expand cssHook pass for ( index in props ) { - name = jQuery.camelCase( index ); + name = camelCase( index ); easing = specialEasing[ name ]; value = props[ index ]; if ( Array.isArray( value ) ) { @@ -7128,9 +7623,9 @@ function Animation( elem, properties, options ) { for ( ; index < length; index++ ) { result = Animation.prefilters[ index ].call( animation, elem, props, animation.opts ); if ( result ) { - if ( jQuery.isFunction( result.stop ) ) { + if ( isFunction( result.stop ) ) { jQuery._queueHooks( animation.elem, animation.opts.queue ).stop = - jQuery.proxy( result.stop, result ); + result.stop.bind( result ); } return result; } @@ -7138,7 +7633,7 @@ function Animation( elem, properties, options ) { jQuery.map( props, createTween, animation ); - if ( jQuery.isFunction( animation.opts.start ) ) { + if ( isFunction( animation.opts.start ) ) { animation.opts.start.call( elem, animation ); } @@ -7171,7 +7666,7 @@ jQuery.Animation = jQuery.extend( Animation, { }, tweener: function( props, callback ) { - if ( jQuery.isFunction( props ) ) { + if ( isFunction( props ) ) { callback = props; props = [ "*" ]; } else { @@ -7203,9 +7698,9 @@ jQuery.Animation = jQuery.extend( Animation, { jQuery.speed = function( speed, easing, fn ) { var opt = speed && typeof speed === "object" ? jQuery.extend( {}, speed ) : { complete: fn || !fn && easing || - jQuery.isFunction( speed ) && speed, + isFunction( speed ) && speed, duration: speed, - easing: fn && easing || easing && !jQuery.isFunction( easing ) && easing + easing: fn && easing || easing && !isFunction( easing ) && easing }; // Go to the end state if fx are off @@ -7232,7 +7727,7 @@ jQuery.speed = function( speed, easing, fn ) { opt.old = opt.complete; opt.complete = function() { - if ( jQuery.isFunction( opt.old ) ) { + if ( isFunction( opt.old ) ) { opt.old.call( this ); } @@ -7284,7 +7779,7 @@ jQuery.fn.extend( { clearQueue = type; type = undefined; } - if ( clearQueue && type !== false ) { + if ( clearQueue ) { this.queue( type || "fx", [] ); } @@ -7367,7 +7862,7 @@ jQuery.fn.extend( { } } ); -jQuery.each( [ "toggle", "show", "hide" ], function( i, name ) { +jQuery.each( [ "toggle", "show", "hide" ], function( _i, name ) { var cssFn = jQuery.fn[ name ]; jQuery.fn[ name ] = function( speed, easing, callback ) { return speed == null || typeof speed === "boolean" ? @@ -7396,7 +7891,7 @@ jQuery.fx.tick = function() { i = 0, timers = jQuery.timers; - fxNow = jQuery.now(); + fxNow = Date.now(); for ( ; i < timers.length; i++ ) { timer = timers[ i ]; @@ -7588,7 +8083,7 @@ boolHook = { } }; -jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( i, name ) { +jQuery.each( jQuery.expr.match.bool.source.match( /\w+/g ), function( _i, name ) { var getter = attrHandle[ name ] || jQuery.find.attr; attrHandle[ name ] = function( elem, name, isXML ) { @@ -7749,7 +8244,7 @@ jQuery.each( [ // Strip and collapse whitespace according to HTML spec - // https://html.spec.whatwg.org/multipage/infrastructure.html#strip-and-collapse-whitespace + // https://infra.spec.whatwg.org/#strip-and-collapse-ascii-whitespace function stripAndCollapse( value ) { var tokens = value.match( rnothtmlwhite ) || []; return tokens.join( " " ); @@ -7760,20 +8255,30 @@ function getClass( elem ) { return elem.getAttribute && elem.getAttribute( "class" ) || ""; } +function classesToArray( value ) { + if ( Array.isArray( value ) ) { + return value; + } + if ( typeof value === "string" ) { + return value.match( rnothtmlwhite ) || []; + } + return []; +} + jQuery.fn.extend( { addClass: function( value ) { var classes, elem, cur, curValue, clazz, j, finalValue, i = 0; - if ( jQuery.isFunction( value ) ) { + if ( isFunction( value ) ) { return this.each( function( j ) { jQuery( this ).addClass( value.call( this, j, getClass( this ) ) ); } ); } - if ( typeof value === "string" && value ) { - classes = value.match( rnothtmlwhite ) || []; + classes = classesToArray( value ); + if ( classes.length ) { while ( ( elem = this[ i++ ] ) ) { curValue = getClass( elem ); cur = elem.nodeType === 1 && ( " " + stripAndCollapse( curValue ) + " " ); @@ -7802,7 +8307,7 @@ jQuery.fn.extend( { var classes, elem, cur, curValue, clazz, j, finalValue, i = 0; - if ( jQuery.isFunction( value ) ) { + if ( isFunction( value ) ) { return this.each( function( j ) { jQuery( this ).removeClass( value.call( this, j, getClass( this ) ) ); } ); @@ -7812,9 +8317,9 @@ jQuery.fn.extend( { return this.attr( "class", "" ); } - if ( typeof value === "string" && value ) { - classes = value.match( rnothtmlwhite ) || []; + classes = classesToArray( value ); + if ( classes.length ) { while ( ( elem = this[ i++ ] ) ) { curValue = getClass( elem ); @@ -7844,13 +8349,14 @@ jQuery.fn.extend( { }, toggleClass: function( value, stateVal ) { - var type = typeof value; + var type = typeof value, + isValidValue = type === "string" || Array.isArray( value ); - if ( typeof stateVal === "boolean" && type === "string" ) { + if ( typeof stateVal === "boolean" && isValidValue ) { return stateVal ? this.addClass( value ) : this.removeClass( value ); } - if ( jQuery.isFunction( value ) ) { + if ( isFunction( value ) ) { return this.each( function( i ) { jQuery( this ).toggleClass( value.call( this, i, getClass( this ), stateVal ), @@ -7862,12 +8368,12 @@ jQuery.fn.extend( { return this.each( function() { var className, i, self, classNames; - if ( type === "string" ) { + if ( isValidValue ) { // Toggle individual class names i = 0; self = jQuery( this ); - classNames = value.match( rnothtmlwhite ) || []; + classNames = classesToArray( value ); while ( ( className = classNames[ i++ ] ) ) { @@ -7926,7 +8432,7 @@ var rreturn = /\r/g; jQuery.fn.extend( { val: function( value ) { - var hooks, ret, isFunction, + var hooks, ret, valueIsFunction, elem = this[ 0 ]; if ( !arguments.length ) { @@ -7955,7 +8461,7 @@ jQuery.fn.extend( { return; } - isFunction = jQuery.isFunction( value ); + valueIsFunction = isFunction( value ); return this.each( function( i ) { var val; @@ -7964,7 +8470,7 @@ jQuery.fn.extend( { return; } - if ( isFunction ) { + if ( valueIsFunction ) { val = value.call( this, i, jQuery( this ).val() ); } else { val = value; @@ -8106,18 +8612,24 @@ jQuery.each( [ "radio", "checkbox" ], function() { // Return jQuery for attributes-only inclusion -var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/; +support.focusin = "onfocusin" in window; + + +var rfocusMorph = /^(?:focusinfocus|focusoutblur)$/, + stopPropagationCallback = function( e ) { + e.stopPropagation(); + }; jQuery.extend( jQuery.event, { trigger: function( event, data, elem, onlyHandlers ) { - var i, cur, tmp, bubbleType, ontype, handle, special, + var i, cur, tmp, bubbleType, ontype, handle, special, lastElement, eventPath = [ elem || document ], type = hasOwn.call( event, "type" ) ? event.type : event, namespaces = hasOwn.call( event, "namespace" ) ? event.namespace.split( "." ) : []; - cur = tmp = elem = elem || document; + cur = lastElement = tmp = elem = elem || document; // Don't do events on text and comment nodes if ( elem.nodeType === 3 || elem.nodeType === 8 ) { @@ -8169,7 +8681,7 @@ jQuery.extend( jQuery.event, { // Determine event propagation path in advance, per W3C events spec (#9951) // Bubble up to document, then to window; watch for a global ownerDocument var (#9724) - if ( !onlyHandlers && !special.noBubble && !jQuery.isWindow( elem ) ) { + if ( !onlyHandlers && !special.noBubble && !isWindow( elem ) ) { bubbleType = special.delegateType || type; if ( !rfocusMorph.test( bubbleType + type ) ) { @@ -8189,13 +8701,15 @@ jQuery.extend( jQuery.event, { // Fire handlers on the event path i = 0; while ( ( cur = eventPath[ i++ ] ) && !event.isPropagationStopped() ) { - + lastElement = cur; event.type = i > 1 ? bubbleType : special.bindType || type; // jQuery handler - handle = ( dataPriv.get( cur, "events" ) || {} )[ event.type ] && + handle = ( + dataPriv.get( cur, "events" ) || Object.create( null ) + )[ event.type ] && dataPriv.get( cur, "handle" ); if ( handle ) { handle.apply( cur, data ); @@ -8221,7 +8735,7 @@ jQuery.extend( jQuery.event, { // Call a native DOM method on the target with the same name as the event. // Don't do default actions on window, that's where global variables be (#6170) - if ( ontype && jQuery.isFunction( elem[ type ] ) && !jQuery.isWindow( elem ) ) { + if ( ontype && isFunction( elem[ type ] ) && !isWindow( elem ) ) { // Don't re-trigger an onFOO event when we call its FOO() method tmp = elem[ ontype ]; @@ -8232,7 +8746,17 @@ jQuery.extend( jQuery.event, { // Prevent re-triggering of the same event, since we already bubbled it above jQuery.event.triggered = type; + + if ( event.isPropagationStopped() ) { + lastElement.addEventListener( type, stopPropagationCallback ); + } + elem[ type ](); + + if ( event.isPropagationStopped() ) { + lastElement.removeEventListener( type, stopPropagationCallback ); + } + jQuery.event.triggered = undefined; if ( tmp ) { @@ -8278,31 +8802,6 @@ jQuery.fn.extend( { } ); -jQuery.each( ( "blur focus focusin focusout resize scroll click dblclick " + - "mousedown mouseup mousemove mouseover mouseout mouseenter mouseleave " + - "change select submit keydown keypress keyup contextmenu" ).split( " " ), - function( i, name ) { - - // Handle event binding - jQuery.fn[ name ] = function( data, fn ) { - return arguments.length > 0 ? - this.on( name, null, data, fn ) : - this.trigger( name ); - }; -} ); - -jQuery.fn.extend( { - hover: function( fnOver, fnOut ) { - return this.mouseenter( fnOver ).mouseleave( fnOut || fnOver ); - } -} ); - - - - -support.focusin = "onfocusin" in window; - - // Support: Firefox <=44 // Firefox doesn't have focus(in | out) events // Related ticket - https://bugzilla.mozilla.org/show_bug.cgi?id=687787 @@ -8321,7 +8820,10 @@ if ( !support.focusin ) { jQuery.event.special[ fix ] = { setup: function() { - var doc = this.ownerDocument || this, + + // Handle: regular nodes (via `this.ownerDocument`), window + // (via `this.document`) & document (via `this`). + var doc = this.ownerDocument || this.document || this, attaches = dataPriv.access( doc, fix ); if ( !attaches ) { @@ -8330,7 +8832,7 @@ if ( !support.focusin ) { dataPriv.access( doc, fix, ( attaches || 0 ) + 1 ); }, teardown: function() { - var doc = this.ownerDocument || this, + var doc = this.ownerDocument || this.document || this, attaches = dataPriv.access( doc, fix ) - 1; if ( !attaches ) { @@ -8346,7 +8848,7 @@ if ( !support.focusin ) { } var location = window.location; -var nonce = jQuery.now(); +var nonce = { guid: Date.now() }; var rquery = ( /\?/ ); @@ -8404,7 +8906,7 @@ function buildParams( prefix, obj, traditional, add ) { } } ); - } else if ( !traditional && jQuery.type( obj ) === "object" ) { + } else if ( !traditional && toType( obj ) === "object" ) { // Serialize object item. for ( name in obj ) { @@ -8426,7 +8928,7 @@ jQuery.param = function( a, traditional ) { add = function( key, valueOrFunction ) { // If value is a function, invoke it and use its return value - var value = jQuery.isFunction( valueOrFunction ) ? + var value = isFunction( valueOrFunction ) ? valueOrFunction() : valueOrFunction; @@ -8434,6 +8936,10 @@ jQuery.param = function( a, traditional ) { encodeURIComponent( value == null ? "" : value ); }; + if ( a == null ) { + return ""; + } + // If an array was passed in, assume that it is an array of form elements. if ( Array.isArray( a ) || ( a.jquery && !jQuery.isPlainObject( a ) ) ) { @@ -8474,7 +8980,7 @@ jQuery.fn.extend( { rsubmittable.test( this.nodeName ) && !rsubmitterTypes.test( type ) && ( this.checked || !rcheckableType.test( type ) ); } ) - .map( function( i, elem ) { + .map( function( _i, elem ) { var val = jQuery( this ).val(); if ( val == null ) { @@ -8544,7 +9050,7 @@ function addToPrefiltersOrTransports( structure ) { i = 0, dataTypes = dataTypeExpression.toLowerCase().match( rnothtmlwhite ) || []; - if ( jQuery.isFunction( func ) ) { + if ( isFunction( func ) ) { // For each dataType in the dataTypeExpression while ( ( dataType = dataTypes[ i++ ] ) ) { @@ -8936,12 +9442,14 @@ jQuery.extend( { if ( !responseHeaders ) { responseHeaders = {}; while ( ( match = rheaders.exec( responseHeadersString ) ) ) { - responseHeaders[ match[ 1 ].toLowerCase() ] = match[ 2 ]; + responseHeaders[ match[ 1 ].toLowerCase() + " " ] = + ( responseHeaders[ match[ 1 ].toLowerCase() + " " ] || [] ) + .concat( match[ 2 ] ); } } - match = responseHeaders[ key.toLowerCase() ]; + match = responseHeaders[ key.toLowerCase() + " " ]; } - return match == null ? null : match; + return match == null ? null : match.join( ", " ); }, // Raw string @@ -9016,7 +9524,7 @@ jQuery.extend( { if ( s.crossDomain == null ) { urlAnchor = document.createElement( "a" ); - // Support: IE <=8 - 11, Edge 12 - 13 + // Support: IE <=8 - 11, Edge 12 - 15 // IE throws exception on accessing the href property if url is malformed, // e.g. http://example.com:80x/ try { @@ -9074,8 +9582,8 @@ jQuery.extend( { // Remember the hash so we can put it back uncached = s.url.slice( cacheURL.length ); - // If data is available, append data to url - if ( s.data ) { + // If data is available and should be processed, append data to url + if ( s.data && ( s.processData || typeof s.data === "string" ) ) { cacheURL += ( rquery.test( cacheURL ) ? "&" : "?" ) + s.data; // #9682: remove data so that it's not used in an eventual retry @@ -9085,7 +9593,8 @@ jQuery.extend( { // Add or update anti-cache param if needed if ( s.cache === false ) { cacheURL = cacheURL.replace( rantiCache, "$1" ); - uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce++ ) + uncached; + uncached = ( rquery.test( cacheURL ) ? "&" : "?" ) + "_=" + ( nonce.guid++ ) + + uncached; } // Put hash and anti-cache on the URL that will be requested (gh-1732) @@ -9218,6 +9727,11 @@ jQuery.extend( { response = ajaxHandleResponses( s, jqXHR, responses ); } + // Use a noop converter for missing script + if ( !isSuccess && jQuery.inArray( "script", s.dataTypes ) > -1 ) { + s.converters[ "text script" ] = function() {}; + } + // Convert no matter what (that way responseXXX fields are always set) response = ajaxConvert( s, response, jqXHR, isSuccess ); @@ -9308,11 +9822,11 @@ jQuery.extend( { } } ); -jQuery.each( [ "get", "post" ], function( i, method ) { +jQuery.each( [ "get", "post" ], function( _i, method ) { jQuery[ method ] = function( url, data, callback, type ) { // Shift arguments if data argument was omitted - if ( jQuery.isFunction( data ) ) { + if ( isFunction( data ) ) { type = type || callback; callback = data; data = undefined; @@ -9329,8 +9843,17 @@ jQuery.each( [ "get", "post" ], function( i, method ) { }; } ); +jQuery.ajaxPrefilter( function( s ) { + var i; + for ( i in s.headers ) { + if ( i.toLowerCase() === "content-type" ) { + s.contentType = s.headers[ i ] || ""; + } + } +} ); + -jQuery._evalUrl = function( url ) { +jQuery._evalUrl = function( url, options, doc ) { return jQuery.ajax( { url: url, @@ -9340,7 +9863,16 @@ jQuery._evalUrl = function( url ) { cache: true, async: false, global: false, - "throws": true + + // Only evaluate the response if it is successful (gh-4126) + // dataFilter is not invoked for failure responses, so using it instead + // of the default converter is kludgy but it works. + converters: { + "text script": function() {} + }, + dataFilter: function( response ) { + jQuery.globalEval( response, options, doc ); + } } ); }; @@ -9350,7 +9882,7 @@ jQuery.fn.extend( { var wrap; if ( this[ 0 ] ) { - if ( jQuery.isFunction( html ) ) { + if ( isFunction( html ) ) { html = html.call( this[ 0 ] ); } @@ -9376,7 +9908,7 @@ jQuery.fn.extend( { }, wrapInner: function( html ) { - if ( jQuery.isFunction( html ) ) { + if ( isFunction( html ) ) { return this.each( function( i ) { jQuery( this ).wrapInner( html.call( this, i ) ); } ); @@ -9396,10 +9928,10 @@ jQuery.fn.extend( { }, wrap: function( html ) { - var isFunction = jQuery.isFunction( html ); + var htmlIsFunction = isFunction( html ); return this.each( function( i ) { - jQuery( this ).wrapAll( isFunction ? html.call( this, i ) : html ); + jQuery( this ).wrapAll( htmlIsFunction ? html.call( this, i ) : html ); } ); }, @@ -9491,7 +10023,8 @@ jQuery.ajaxTransport( function( options ) { return function() { if ( callback ) { callback = errorCallback = xhr.onload = - xhr.onerror = xhr.onabort = xhr.onreadystatechange = null; + xhr.onerror = xhr.onabort = xhr.ontimeout = + xhr.onreadystatechange = null; if ( type === "abort" ) { xhr.abort(); @@ -9531,7 +10064,7 @@ jQuery.ajaxTransport( function( options ) { // Listen to events xhr.onload = callback(); - errorCallback = xhr.onerror = callback( "error" ); + errorCallback = xhr.onerror = xhr.ontimeout = callback( "error" ); // Support: IE 9 only // Use onreadystatechange to replace onabort @@ -9622,24 +10155,21 @@ jQuery.ajaxPrefilter( "script", function( s ) { // Bind script tag hack transport jQuery.ajaxTransport( "script", function( s ) { - // This transport only deals with cross domain requests - if ( s.crossDomain ) { + // This transport only deals with cross domain or forced-by-attrs requests + if ( s.crossDomain || s.scriptAttrs ) { var script, callback; return { send: function( _, complete ) { - script = jQuery( " - - - - - + + + + + + - +
@@ -101,55 +64,55 @@

Advanced installation configurationrtg.bat file in the installation directory. These configuration variables include:

- +
--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
VariableDescription

Variable

Description

RTG_MEMSpecify the maximum memory for Java run-time execution. Use a G suffix for gigabytes, e.g.: RTG_MEM=48G. The default memory allocation is 90% of system memory.

RTG_MEM

Specify the maximum memory for Java run-time execution. Use a G suffix for gigabytes, e.g.: RTG_MEM=48G. The default memory allocation is 90% of system memory.

RTG_JAVASpecify the path to Java (default assumes current path).

RTG_JAVA

Specify the path to Java (default assumes current path).

RTG_JARIndicate the path to the RTG.jar executable (default assumes current path).

RTG_JAR

Indicate the path to the RTG.jar executable (default assumes current path).

RTG_JAVA_OPTSProvide any additional Java JVM options.

RTG_JAVA_OPTS

Provide any additional Java JVM options.

RTG_DEFAULT_THREADSBy default any RTG module with a --threads parameter will automatically use the number of cores as the number of threads. This setting makes the specified number the default for the --threads parameter instead.

RTG_DEFAULT_THREADS

By default any RTG module with a --threads parameter will automatically use the number of cores as the number of threads. This setting makes the specified number the default for the --threads parameter instead.

RTG_PROXYSpecify the http proxy server for TalkBack exception management (default is no http proxy).

RTG_PROXY

Specify the http proxy server for TalkBack exception management (default is no http proxy).

RTG_TALKBACKSend log files for crash-severity exception conditions (default is true, set to false to disable).

RTG_TALKBACK

Send log files for crash-severity exception conditions (default is true, set to false to disable).

RTG_USAGEIf set to true, enable simple usage logging.

RTG_USAGE

If set to true, enable simple usage logging.

RTG_USAGE_DIRDestination directory when performing single-user file-based usage logging.

RTG_USAGE_DIR

Destination directory when performing single-user file-based usage logging.

RTG_USAGE_HOSTServer URL when performing server-based logging.

RTG_USAGE_HOST

Server URL when performing server-based logging.

RTG_USAGE_OPTIONALMay contain a comma-separated list of the names of optional fields to include in usage logging (when enabled). Any of username, hostname and commandline may be set here.

RTG_USAGE_OPTIONAL

May contain a comma-separated list of the names of optional fields to include in usage logging (when enabled). Any of username, hostname and commandline may be set here.

RTG_REFERENCES_DIRSpecifies an alternate directory containing metagenomic pipeline reference datasets.

RTG_REFERENCES_DIR

Specifies an alternate directory containing metagenomic pipeline reference datasets.

RTG_MODELS_DIRSpecifies an alternate directory containing AVR models.

RTG_MODELS_DIR

Specifies an alternate directory containing AVR models.

@@ -236,13 +199,13 @@

Usage logging -
  • Time and date
  • -
  • License serial number
  • -
  • Unique ID for the run
  • -
  • Version of RTG software
  • -
  • RTG command name, without parameters (e.g. map)
  • -
  • Status (Started / Failed / Succeeded)
  • -
  • A command-specific field (e.g. number of reads)
  • +
  • Time and date

  • +
  • License serial number

  • +
  • Unique ID for the run

  • +
  • Version of RTG software

  • +
  • RTG command name, without parameters (e.g. map)

  • +
  • Status (Started / Failed / Succeeded)

  • +
  • A command-specific field (e.g. number of reads)

  • For example:

    +
    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/appendix.html b/installer/resources/core/RTGOperationsManual/appendix.html index bb9c90922..2b5d29010 100644 --- a/installer/resources/core/RTGOperationsManual/appendix.html +++ b/installer/resources/core/RTGOperationsManual/appendix.html @@ -2,26 +2,26 @@ - + - - - Appendix — RTG Core Operations Manual v3.11 + + + Appendix — RTG Core Operations Manual v3.12 - - - - - - + + + + + + - +
    @@ -129,15 +50,15 @@

    RTG gapped alignment technical description[1] to discover differences between two DNA sequences. +edit distance 1 to discover differences between two DNA sequences. The edit operations introduce insertions, deletions, and substitutions to transform one sequence into another. Alignments are termed global if they extend over all residues of both sequences.

    Most programs for finding global alignments are based on the -Needleman-Wunsch algorithm [2]. Alternatively, alignments may be local, +Needleman-Wunsch algorithm 2. Alternatively, alignments may be local, in which case reported alignments may contain subsequences of the input sequences. The Smith-Waterman variation on the Needleman-Wunsch -algorithm finds such alignments [3]. The proprietary RTG algorithm +algorithm finds such alignments 3. The proprietary RTG algorithm employs a further variation of this approach, using a dynamic programming edit-distance calculation for alignment of reads to a reference sequence. The alignment is semi-global in that it always @@ -200,28 +121,21 @@

    Alignment scoring - - -[1]Levenshtein, V. I.(1966) Binary codes capable of correcting deletions, -insertions and reversal. Soviet Physics Doklady, 6:707-710. - - - - - - - -
    [2]Needleman, S. B and Wunsch, C. D. (1970) A general method applicable to +
    +
    1
    +

    Levenshtein, V. I.(1966) Binary codes capable of correcting deletions, +insertions and reversal. Soviet Physics Doklady, 6:707-710.

    +
    +
    2
    +

    Needleman, S. B and Wunsch, C. D. (1970) A general method applicable to the search for similarities in the amino acid sequence of two -proteins. Journal of Molecular Biology, 48:443-453

    - - - - - -
    [3]Smith, T. F. and Waterman, M. S. (1981) Identification of common molecular -subsequences. Journal of Molecular Biology. 147:195-197.
    +proteins. Journal of Molecular Biology, 48:443-453

    + +
    3
    +

    Smith, T. F. and Waterman, M. S. (1981) Identification of common molecular +subsequences. Journal of Molecular Biology. 147:195-197.

    +
    +

    @@ -373,7 +287,8 @@

    RTG reference file format
    either        def     <ploidy>        <shape>
     

    -

    The ploidy field is one of diploid, haploid, polyploid or +

    The ploidy field is one of haploid, diploid, triploid, +tetraploid, pentaploid, hexaploid, polyploid or none. The shape field is one of circular or linear.

    The specific chromosome settings lines are similar to the default chromosome settings lines. All the sex field options can be used, @@ -504,14 +419,14 @@

    RTG taxonomy file format -
  • The unique taxon ID of the node in the tree. This must be an integer -value greater than or equal to 1.
  • -
  • The taxon ID of the parent of this node. This must be an integer -value corresponding to another node in the tree.
  • -
  • The rank of the node in the taxonomy. This is a free format string -that can contain any character other than a tab.
  • -
  • The name of the node in the taxonomy. This is a free format string -that can contain any character other than a tab.
  • +
  • The unique taxon ID of the node in the tree. This must be an integer +value greater than or equal to 1.

  • +
  • The taxon ID of the parent of this node. This must be an integer +value corresponding to another node in the tree.

  • +
  • The rank of the node in the taxonomy. This is a free format string +that can contain any character other than a tab.

  • +
  • The name of the node in the taxonomy. This is a free format string +that can contain any character other than a tab.

  • The root of the tree is special and must have a taxon ID of 1. Since the root has no parent it can have a parent ID of either 1 (itself) or -1. @@ -538,11 +453,11 @@

    RTG taxonomy lookup file format -
  • The taxonomy node ID that the sequence is associated with. This must +
  • The taxonomy node ID that the sequence is associated with. This must be an integer value that corresponds to a node ID from the taxonomy -tree.

  • -
  • The name of the sequence as it appears in the SDF. (These can be -discovered using the --lengths option of the sdfstats command)
  • +tree.

    +
  • The name of the sequence as it appears in the SDF. (These can be +discovered using the --lengths option of the sdfstats command)

  • A single taxon ID may be associated with multiple sequence names. This is a way to group the chromosomes and plasmids belonging to a single @@ -561,40 +476,40 @@

    Pedigree PED input file format# are ignored. It has exactly six required columns in the following order.

    - +
    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + +
    ColumnDefinition

    Column

    Definition

    Family IDAlphanumeric ID of a family group. This field is ignored by RTG commands.

    Family ID

    Alphanumeric ID of a family group. This field is ignored by RTG commands.

    Individual IDAlphanumeric ID of an individual. This corresponds to the Sample ID specified in the read group of the individual (SM field).

    Individual ID

    Alphanumeric ID of an individual. This corresponds to the Sample ID specified in the read group of the individual (SM field).

    Paternal IDAlphanumeric ID of the paternal parent for the individual. This corresponds to the Sample ID specified in the read group of the paternal parent (SM field).

    Paternal ID

    Alphanumeric ID of the paternal parent for the individual. This corresponds to the Sample ID specified in the read group of the paternal parent (SM field).

    Maternal IDAlphanumeric ID of the maternal parent for the individual. This corresponds to the Sample ID specified in the read group of the maternal parent (SM field).

    Maternal ID

    Alphanumeric ID of the maternal parent for the individual. This corresponds to the Sample ID specified in the read group of the maternal parent (SM field).

    SexThe sex of the individual specified as using 1 for male, 2 for female and any other number as unknown.

    Sex

    The sex of the individual specified as using 1 for male, 2 for female and any other number as unknown.

    PhenotypeThe phenotype of the individual specified using -9 or 0 for unknown, 1 for unaffected and 2 for affected.

    Phenotype

    The phenotype of the individual specified using -9 or 0 for unknown, 1 for unaffected and 2 for affected.

    @@ -644,10 +559,10 @@

    Genetic map directory

    The columns in the example are:

      -
    1. Chromosome name
    2. -
    3. Position in chromosome
    4. -
    5. Rate of crossovers in region ending at this position (ignored)
    6. -
    7. Total number of centimorgans from start of sequence
    8. +
    9. Chromosome name

    10. +
    11. Position in chromosome

    12. +
    13. Rate of crossovers in region ending at this position (ignored)

    14. +
    15. Total number of centimorgans from start of sequence

    The corresponding map directory should contain a file or files for each sequence of interest, using the naming convention @@ -669,9 +584,9 @@

    Genetic map directory

    Specific sources include:

    A zip file containing the Bherer genetic map files for human build 37, with the required header manipulations already applied is available for @@ -706,8 +621,8 @@

    SAM/BAM file extensions (RTG map command output) -

    Note

    -

    For a thorough description of the SAM format please refer +

    Note

    +

    For a thorough description of the SAM format please refer to the specification at https://samtools.github.io/hts-specs/SAMv1.pdf

    @@ -760,22 +675,22 @@

    SAM/BAM file extensions (RTG map command output) -
  • Paired-end sequencing data
  • -
  • FLAG is set to 0x02 in properly paired reads and unset for -unmated or unmapped reads.
  • -
  • For all non-uniquely mapped reads FLAG 0x100 is set.
  • -
  • Unmated and unmapped reads will have the FLAG 0x08 set to reflect +
  • Paired-end sequencing data

  • +
  • FLAG is set to 0x02 in properly paired reads and unset for +unmated or unmapped reads.

  • +
  • For all non-uniquely mapped reads FLAG 0x100 is set.

  • +
  • Unmated and unmapped reads will have the FLAG 0x08 set to reflect whether the mate has been mapped, however RNEXT and PNEXT -will always be “*”.

  • -
  • For mapped reads, the SAM standard NH attribute is used, even for -uniquely mapped reads (NH:i:1).
  • -
  • Single-end sequencing data
  • -
  • For all non-uniquely mapped reads FLAG 0x100 is set.
  • -
  • For mapped reads, the SAM standard NH attribute is used, even for -uniquely mapped reads (NH:i:1).
  • -
  • Unmapped reads
  • -
  • RNAME and CIGAR are set as “*”.
  • -
  • POS, and MAPQ are set as 0.
  • +will always be “*”.

    +
  • For mapped reads, the SAM standard NH attribute is used, even for +uniquely mapped reads (NH:i:1).

  • +
  • Single-end sequencing data

  • +
  • For all non-uniquely mapped reads FLAG 0x100 is set.

  • +
  • For mapped reads, the SAM standard NH attribute is used, even for +uniquely mapped reads (NH:i:1).

  • +
  • Unmapped reads

  • +
  • RNAME and CIGAR are set as “*”.

  • +
  • POS, and MAPQ are set as 0.

  • For mated records, the XA attribute contains the sum of the alignment scores for each arm. It is this score that is used to determine the @@ -787,65 +702,65 @@

    SAM/BAM file extensions (RTG map command output) +--++ - - - + + + - - - + + + - - + + - - + + - - + +
    CharacterDefinition

    Character

    Definition

    XC:A:BIndicates that the number of raw index hits for the read exceeded the internal threshold of 65536.

    XC:A:B

    Indicates that the number of raw index hits for the read exceeded the internal threshold of 65536.

    XC:A:CIndicates that after initial ranking of hits for the read, too many hits were present (affected by --max-top-results).

    XC:A:C

    Indicates that after initial ranking of hits for the read, too many hits were present (affected by --max-top-results).

    XC:A:DIndicates that after alignment scores are calculated, the \leq N remaining hits were discarded because they exceeded the mismatches threshold (affected by ---max-mismatches).

    XC:A:D

    Indicates that after alignment scores are calculated, the \leq N remaining hits were discarded because they exceeded the mismatches threshold (affected by +--max-mismatches).

    XC:A:EIndicates that there were good scoring hits, but the arm was discarded because there were too many of these hits (affected by --max-top-results).

    XC:A:E

    Indicates that there were good scoring hits, but the arm was discarded because there were too many of these hits (affected by --max-top-results).

    Paired-end SAM character codes include:

    - +
    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + +
    CharacterDefinition

    Character

    Definition

    XC:A:BIndicates that the number of raw index hits for the read exceeded the internal threshold of 65536.

    XC:A:B

    Indicates that the number of raw index hits for the read exceeded the internal threshold of 65536.

    XC:A:CIndicates that there were index matches for the read arm, but no potential mated hits were found (affected by --min-fragment-size and ---max-fragment-size), and after ranking candidate unpaired results there were too many hits (affected by --max-top-results).

    XC:A:C

    Indicates that there were index matches for the read arm, but no potential mated hits were found (affected by --min-fragment-size and +--max-fragment-size), and after ranking candidate unpaired results there were too many hits (affected by --max-top-results).

    XC:A:dIndicates that potential mated hits were found for this read arm with its mate, but were discarded because they exceeded the mismatches threshold (affected by ---max-mated-mismatches).

    XC:A:d

    Indicates that potential mated hits were found for this read arm with its mate, but were discarded because they exceeded the mismatches threshold (affected by +--max-mated-mismatches).

    XC:A:DIndicates that no potential mated hits were found, and after alignment scores are calculated, the (\leq N) -remaining hits were discarded because they exceeded the mismatches threshold (affected by --max-unmated-mismatches).

    XC:A:D

    Indicates that no potential mated hits were found, and after alignment scores are calculated, the (\leq N) +remaining hits were discarded because they exceeded the mismatches threshold (affected by --max-unmated-mismatches).

    XC:A:eIndicates that good scoring hits were found for this read arm with its mate, but were discarded because there were too many hits at the best score (affected by ---max-top-results).

    XC:A:e

    Indicates that good scoring hits were found for this read arm with its mate, but were discarded because there were too many hits at the best score (affected by +--max-top-results).

    XC:A:EIndicates that no potential mated hits were found, there were good scoring unmated hits, but the arm was discarded because there were too many of these hits (affected by --max-top-results).

    XC:A:E

    Indicates that no potential mated hits were found, there were good scoring unmated hits, but the arm was discarded because there were too many of these hits (affected by --max-top-results).

    @@ -947,8 +862,8 @@

    Small-variant VCF output file descriptionsnps.vcf.

    -

    Note

    -

    RTG variant calls are stored in VCF format (version +

    Note

    +

    RTG variant calls are stored in VCF format (version 4.2). For more information about the VCF format, refer to the specification online at: https://samtools.github.io/hts-specs/VCFv4.2.pdf

    @@ -1001,8 +916,8 @@

    Small-variant VCF output file description -

    Note

    -

    The VCF specification defines the semantics of the QUAL +

    Note

    +

    The VCF specification defines the semantics of the QUAL column differently for records that contain any ALT alleles from those which do not, and that the QUAL column is also defined as a score applying across the set of all samples in the VCF. Thus for @@ -1015,268 +930,268 @@

    Small-variant VCF output file description +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    ValueDescription

    Value

    Description

    PASSStandard VCF PASS, if variant meets all the filtering criteria.

    PASS

    Standard VCF PASS, if variant meets all the filtering criteria.

    OCA predicted variation that has exceeded the maximum coverage filter threshold.

    OC

    A predicted variation that has exceeded the maximum coverage filter threshold.

    a<number>A predicted variation that had greater than the given percentage of ambiguously mapped reads overlapping it. The number in the value is the percentage specified by the --max-ambiguity flag.

    a<number>

    A predicted variation that had greater than the given percentage of ambiguously mapped reads overlapping it. The number in the value is the percentage specified by the --max-ambiguity flag.

    RCEQUIVA predicted variation that is the same as a previous variant within a homopolymer or repeat region.

    RCEQUIV

    A predicted variation that is the same as a previous variant within a homopolymer or repeat region.

    RCThe variant caller encountered a complex looking situation. A typical example would be a long insert. Some complex regions may result in simple calls.

    RC

    The variant caller encountered a complex looking situation. A typical example would be a long insert. Some complex regions may result in simple calls.

    RXThis call was made within a long complex region. Note that no attempt is made to generate complex calls in very long complex regions.

    RX

    This call was made within a long complex region. Note that no attempt is made to generate complex calls in very long complex regions.

    IONTA predicted variation that failed to pass homopolymer constraints specific to IonTorrent reads.

    IONT

    A predicted variation that failed to pass homopolymer constraints specific to IonTorrent reads.

    OTHERThe variant was filtered for an unknown reason.

    OTHER

    The variant was filtered for an unknown reason.

    AVR<number>A predicted variation that had less than the given value for the AVR score. The number in the value is the minimum AVR score specified by the --min-avr-score flag.

    AVR<number>

    A predicted variation that had less than the given value for the AVR score. The number in the value is the minimum AVR score specified by the --min-avr-score flag.

    BEDThe predicted variant falls outside the BED calling regions defined by the --filter-bed flag.

    BED

    The predicted variant falls outside the BED calling regions defined by the --filter-bed flag.

    Table : RTG VCF file INFO fields

    - +
    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    ValueDescription

    Value

    Description

    NCS=<value>The Phred scaled posterior probability that the variant at this site is present in the cancer, output by the somatic command.

    NCS=<value>

    The Phred scaled posterior probability that the variant at this site is present in the cancer, output by the somatic command.

    LOH=<value>The value shows on a scale from -1 to 1 if the evidence of a call would suggest a loss of heterozygosity. A long run of high values is a strong indicator of a loss of heterozygosity event.

    LOH=<value>

    The value shows on a scale from -1 to 1 if the evidence of a call would suggest a loss of heterozygosity. A long run of high values is a strong indicator of a loss of heterozygosity event.

    DP=<depth>The combined read depth of multi-sample variant calls.

    DP=<depth>

    The combined read depth of multi-sample variant calls.

    DPR=<ratio>The ratio of combined read depth to the expected combined read depth.

    DPR=<ratio>

    The ratio of combined read depth to the expected combined read depth.

    XRXIndicates the variant was called using the RTG complex caller. This means that a realignment of the reads relative to the reference and each other was required to make this call.

    XRX

    Indicates the variant was called using the RTG complex caller. This means that a realignment of the reads relative to the reference and each other was required to make this call.

    RCEIndicates the variant is the same as one or more other variants within a homopolymer or repeat region.

    RCE

    Indicates the variant is the same as one or more other variants within a homopolymer or repeat region.

    NREFIndicates the variant is called at a site where the reference is unknown, and so some other scores that require exact knowledge of the reference may not be produced.

    NREF

    Indicates the variant is called at a site where the reference is unknown, and so some other scores that require exact knowledge of the reference may not be produced.

    CT=<value>The maximum coverage threshold that was applied when the given variant has been filtered for being over the coverage threshold.

    CT=<value>

    The maximum coverage threshold that was applied when the given variant has been filtered for being over the coverage threshold.

    ACThe standard VCF allele count in genotypes field. For each ALT allele, in the same order as listed, the count of the allele in the genotypes.

    AC

    The standard VCF allele count in genotypes field. For each ALT allele, in the same order as listed, the count of the allele in the genotypes.

    ANThe standard VCF total number of alleles in called genotypes field.

    AN

    The standard VCF total number of alleles in called genotypes field.

    STRLThe number of adjacent simple tandem repeats on the reference sequence.

    STRL

    The number of adjacent simple tandem repeats on the reference sequence.

    STRUThe length of the repeating unit in a simple tandem repeat.

    STRU

    The length of the repeating unit in a simple tandem repeat.

    Table : RTG VCF file FORMAT fields

    - +
    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + - - + - - + - - + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    ValueDescription

    Value

    Description

    GTThe standard VCF format genotype field.

    GT

    The standard VCF format genotype field.

    DPThe standard VCF format read depth field.

    DP

    The standard VCF format read depth field.

    DPRThe ratio of read depth to the expected read depth.

    DPR

    The ratio of read depth to the expected read depth.

    VAThe allele index (using same numbering as the GT field) of the most frequent non-REF allele. This allele may not necessarily be part of the genotype that was actually called.

    VA

    The allele index (using same numbering as the GT field) of the most frequent non-REF allele. This allele may not necessarily be part of the genotype that was actually called.

    REThe total error across bases of the reads at the SNP location. This is a corrective factor calculated from the r and q read mapping quality scores that adjusts the level of confidence higher or lower relative to read depth.

    RE

    The total error across bases of the reads at the SNP location. This is a corrective factor calculated from the r and q read mapping quality scores that adjusts the level of confidence higher or lower relative to read depth.

    ARThe ratio of reads contributing to the variant that are considered to be ambiguous to uniquely mapped reads.

    AR

    The ratio of reads contributing to the variant that are considered to be ambiguous to uniquely mapped reads.

    RQThe Phred scaled posterior probability that the sample is not identical to the reference.

    RQ

    The Phred scaled posterior probability that the sample is not identical to the reference.

    GQThe standard VCF format genotype quality field. This is the Phred scaled posterior score of the call. It is not necessarily the same as the QUAL column score.

    GQ

    The standard VCF format genotype quality field. This is the Phred scaled posterior score of the call. It is not necessarily the same as the QUAL column score.

    GQDThe genotype quality divided by the read depth of the sample.

    GQD

    The genotype quality divided by the read depth of the sample.

    QDThe quality field divided by the sum of the read depth for all samples.

    QD

    The quality field divided by the sum of the read depth for all samples.

    DNIndicates with a value of Y if the call for this sample is a putative de novo mutation, or N to indicate that the sample is not a de novo mutation. Note that even in cases when the GT of the sample and the parents would otherwise seem to indicate a de novo mutation, this field may be set to N when the variant caller has assigned a sufficiently low score to the likelihood that a de novo event has occurred.

    DN

    Indicates with a value of Y if the call for this sample is a putative de novo mutation, or N to indicate that the sample is not a de novo mutation. Note that even in cases when the GT of the sample and the parents would otherwise seem to indicate a de novo mutation, this field may be set to N when the variant caller has assigned a sufficiently low score to the likelihood that a de novo event has occurred.

    DNPThe Phred scaled probability that the call for this sample is due to a de novo mutation.

    DNP

    The Phred scaled probability that the call for this sample is due to a de novo mutation.

    OCOC

    The count of evidence that is considered contrary to the call made for this sample, observed in the original sample.

    +

    OCOC

    The count of evidence that is considered contrary to the call made for this sample, observed in the original sample.

    For example, in a normal-cancer somatic call of 0/0 -> 1/0, the OCOC value is the count of the somatic (1) allele in the normal sample.

    -

    Usually a high OCOC value indicates an unreliable call.

    +

    Usually a high OCOC value indicates an unreliable call.

    OCOF

    The fraction of evidence that is considered contrary to the call made for this sample, observed in the original sample.

    +

    OCOF

    The fraction of evidence that is considered contrary to the call made for this sample, observed in the original sample.

    For example, in a somatic call of 0/0 -> 1/0, the OCOF value is the fraction of the somatic (1) allele in the normal sample.

    The OCOF and OCOC attributes are also applicable to de novo calls, where the evidence in the parents for the de novo allele is considered contrary.

    -

    Usually a high OCOF value indicates an unreliable call.

    +

    Usually a high OCOF value indicates an unreliable call.

    DCOC

    The count of evidence that is considered contrary to the call made for this sample, observed in the derived sample.

    +

    DCOC

    The count of evidence that is considered contrary to the call made for this sample, observed in the derived sample.

    For example, in a normal-cancer somatic call of 0/1 -> 2/0, the DCOC value is the count of the germline (1) allele in the somatic sample.

    -

    In cases of high sample purity, a high DCOC value may indicate an unreliable call.

    +

    In cases of high sample purity, a high DCOC value may indicate an unreliable call.

    DCOF

    The fraction of evidence that is considered contrary to the call made for this sample, observed in the derived sample.

    +

    DCOF

    The fraction of evidence that is considered contrary to the call made for this sample, observed in the derived sample.

    For example, in a somatic call of 0/1 -> 2/0, the DCOF value is the fraction of the germline (1) allele in the somatic sample.

    The DCOF and DCOC attributes are also applicable to pedigree aware calls, where the evidence of non-inherited parental alleles in the child is considered contrary.

    -

    In cases of high sample purity, a high DCOF value may indicate an unreliable call.

    +

    In cases of high sample purity, a high DCOF value may indicate an unreliable call.

    ABPThe Phred scaled probability that allele imbalance is present in the call.

    ABP

    The Phred scaled probability that allele imbalance is present in the call.

    SBPThe Phred scaled probability that strand bias is present in the call.

    SBP

    The Phred scaled probability that strand bias is present in the call.

    RPBThe Phred scaled probability that read position bias is present in the call.

    RPB

    The Phred scaled probability that read position bias is present in the call.

    PPBThe Phred scaled probability that bias in the proportion of alignments that are properly paired is present in the call.

    PPB

    The Phred scaled probability that bias in the proportion of alignments that are properly paired is present in the call.

    PURThe ratio of placed unmapped reads to mapped reads.

    PUR

    The ratio of placed unmapped reads to mapped reads.

    RSStatistical information about the evidence for the prediction which consists of a variable number of groups of three fields, each separated by commas. The three fields are allele, count, and the sum of probability error (computed from the Phred quality). The sum of counts should equal DP and the sum of the errors should equal RE.

    RS

    Statistical information about the evidence for the prediction which consists of a variable number of groups of three fields, each separated by commas. The three fields are allele, count, and the sum of probability error (computed from the Phred quality). The sum of counts should equal DP and the sum of the errors should equal RE.

    DHAn alternative disagreeing hypothesis in the same format as the genotype field. This can occur when a sample intersects multiple families in a pedigree when doing population calling.

    DH

    An alternative disagreeing hypothesis in the same format as the genotype field. This can occur when a sample intersects multiple families in a pedigree when doing population calling.

    ADThe allelic depths for the reference and alternate alleles in the order listed.

    AD

    The allelic depths for the reference and alternate alleles in the order listed.

    ADEThe allelic depths for the reference and alternate alleles in the order listed, after adjusting for poor base quality and mapping quality.

    ADE

    The allelic depths for the reference and alternate alleles in the order listed, after adjusting for poor base quality and mapping quality.

    ADFThe allelic depths for the reference and alternate alleles in the order listed, for reads on the forward strand.

    ADF

    The allelic depths for the reference and alternate alleles in the order listed, for reads on the forward strand.

    ADRThe allelic depths for the reference and alternate alleles in the order listed, for reads on the reverse strand.

    ADR

    The allelic depths for the reference and alternate alleles in the order listed, for reads on the reverse strand.

    ADF1The allelic depths for the reference and alternate alleles in the order listed, for arm 1 reads on the forward strand.

    ADF1

    The allelic depths for the reference and alternate alleles in the order listed, for arm 1 reads on the forward strand.

    ADF2The allelic depths for the reference and alternate alleles in the order listed, for arm 2 reads on the forward strand.

    ADF2

    The allelic depths for the reference and alternate alleles in the order listed, for arm 2 reads on the forward strand.

    ADR1The allelic depths for the reference and alternate alleles in the order listed, for arm 1 reads on the reverse strand.

    ADR1

    The allelic depths for the reference and alternate alleles in the order listed, for arm 1 reads on the reverse strand.

    ADR2The allelic depths for the reference and alternate alleles in the order listed, for arm 2 reads on the reverse strand.

    ADR2

    The allelic depths for the reference and alternate alleles in the order listed, for arm 2 reads on the reverse strand.

    AQThe sum of the quality of evidence (including base quality and mapping quality) for the reference and alternate alleles in the order listed.

    AQ

    The sum of the quality of evidence (including base quality and mapping quality) for the reference and alternate alleles in the order listed.

    MEANQADThe difference in the mean AQ between the two called alleles.

    MEANQAD

    The difference in the mean AQ between the two called alleles.

    SSCThe score for the somatic mutation specified by the GT field.

    SSC

    The score for the somatic mutation specified by the GT field.

    SSThe somatic status of the genotype for this sample. A value of 0 indicates none or wild type, a value of 1 indicates a germline variant, and a value of 2 indicates a somatic variant.

    SS

    The somatic status of the genotype for this sample. A value of 0 indicates none or wild type, a value of 1 indicates a germline variant, and a value of 2 indicates a somatic variant.

    GLThe log10 scaled likelihoods for all possible genotypes given the set of alleles defined in the REF and ALT fields as defined in the VCF specifications.

    GL

    The log10 scaled likelihoods for all possible genotypes given the set of alleles defined in the REF and ALT fields as defined in the VCF specifications.

    VAFThe VAF field contains the estimated variant allelic fraction of each alternate allele, in the order listed.

    VAF

    The VAF field contains the estimated variant allelic fraction of each alternate allele, in the order listed.

    VAF1The VAF1 field contains the estimated variant allelic fraction of the most abundant non-reference allele. This attribute may be more suitable for AVR model building and filtering than the multi-valued VAF annotation.

    VAF1

    The VAF1 field contains the estimated variant allelic fraction of the most abundant non-reference allele. This attribute may be more suitable for AVR model building and filtering than the multi-valued VAF annotation.

    ICThe inbreeding coefficient for the site.

    IC

    The inbreeding coefficient for the site.

    EPThe Phred scaled probability that the site is not in Hardy-Weinberg equilibrium.

    EP

    The Phred scaled probability that the site is not in Hardy-Weinberg equilibrium.

    LALThe length of the longest allele for the site.

    LAL

    The length of the longest allele for the site.

    NAAThe number of alternate alleles for the site.

    NAA

    The number of alternate alleles for the site.

    PDThe ploidy of the sample.

    PD

    The ploidy of the sample.

    ZYThe zygosity of the sample.

    ZY

    The zygosity of the sample.

    RACategorizes the call as hom-ref (RR), hom-alt (AA), het-ref (RA), or het-alt (AB), independent of phase or ALT allele indices.

    RA

    Categorizes the call as hom-ref (RR), hom-alt (AA), het-ref (RA), or het-alt (AB), independent of phase or ALT allele indices.

    QASum of quality of the alternate observations.

    QA

    Sum of quality of the alternate observations.

    CLUSThe number of variants in this sample within five bases of the current variant.

    CLUS

    The number of variants in this sample within five bases of the current variant.

    AVRThe adaptive variant rescoring value. It is a value between 0 and 1 that represents the probability that the variant for the sample is correct.

    AVR

    The adaptive variant rescoring value. It is a value between 0 and 1 that represents the probability that the variant for the sample is correct.

    @@ -1349,43 +1264,43 @@

    Regions BED output file description -
  • Sequence name
  • -
  • Region start, counting from 0
  • -
  • Region end, counting from 0, not inclusive
  • -
  • Name of the region type
  • +
  • Sequence name

  • +
  • Region start, counting from 0

  • +
  • Region end, counting from 0, not inclusive

  • +
  • Name of the region type

  • Table : Region type names

    - +
    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + +
    ValueDescription

    Value

    Description

    complex-calledComplex regions that were called using complex calling.

    complex-called

    Complex regions that were called using complex calling.

    hyper-complexLong complex regions for which no call attempt was made.

    hyper-complex

    Long complex regions for which no call attempt was made.

    extreme-coverageNo calls made in this region due to extreme coverage.

    extreme-coverage

    No calls made in this region due to extreme coverage.

    complex-over-coverageComplex region has greater than the maximum coverage allowed.

    complex-over-coverage

    Complex region has greater than the maximum coverage allowed.

    complex-no-hypothesesNo hypotheses could be created for the complex region.

    complex-no-hypotheses

    No hypotheses could be created for the complex region.

    complex-no-variantComplex region evaluation resulted in no variants.

    complex-no-variant

    Complex region evaluation resulted in no variants.

    complex-too-many-hypothesesComplex region had too many hypotheses for evaluation.

    complex-too-many-hypotheses

    Complex region had too many hypotheses for evaluation.

    @@ -1404,34 +1319,34 @@

    SV command output file descriptions +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    chrThe chromosome name.

    chr

    The chromosome name.

    startThe start position in the reference chromosome.

    start

    The start position in the reference chromosome.

    endThe end position in the reference chromosome.

    end

    The end position in the reference chromosome.

    areasThe number of distinct model areas contained in the region.

    areas

    The number of distinct model areas contained in the region.

    maxscoreThe maximum score reached by a model in the given region.

    maxscore

    The maximum score reached by a model in the given region.

    averageThe average score for the model areas covered by this region.

    average

    The average score for the model areas covered by this region.

    @@ -1455,52 +1370,52 @@

    SV command output file descriptions +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    template-nameThe chromosome name.

    template-name

    The chromosome name.

    positionThe position in the reference chromosome.

    position

    The position in the reference chromosome.

    normalThe prediction strength for the normal model.

    normal

    The prediction strength for the normal model.

    duplicateThe prediction strength for the duplicate model.

    duplicate

    The prediction strength for the duplicate model.

    deleteThe prediction strength for the delete model.

    delete

    The prediction strength for the delete model.

    delete-leftThe prediction strength for the delete-left model.

    delete-left

    The prediction strength for the delete-left model.

    delete-rightThe prediction strength for the delete-right model.

    delete-right

    The prediction strength for the delete-right model.

    duplicate-leftThe prediction strength for the duplicate-left model.

    duplicate-left

    The prediction strength for the duplicate-left model.

    duplicate-rightThe prediction strength for the duplicate-right model.

    duplicate-right

    The prediction strength for the duplicate-right model.

    breakpointThe prediction strength for the breakpoint model.

    breakpoint

    The prediction strength for the breakpoint model.

    novel-insertionThe prediction strength for the novel-insertion model.

    novel-insertion

    The prediction strength for the novel-insertion model.

    max-indexThe index of the model that has the maximum prediction strength for this line. The index starts from 0 meaning normal and is in the same order as the model columns.

    max-index

    The index of the model that has the maximum prediction strength for this line. The index starts from 0 meaning normal and is in the same order as the model columns.

    @@ -1527,52 +1442,52 @@

    SV command output file descriptions +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    template-nameThe chromosome name.

    template-name

    The chromosome name.

    positionThe position in the reference chromosome.

    position

    The position in the reference chromosome.

    proper-leftCount of properly paired left reads mapped in this location.

    proper-left

    Count of properly paired left reads mapped in this location.

    discordant-leftCount of discordantly paired left reads mapped in this location.

    discordant-left

    Count of discordantly paired left reads mapped in this location.

    unmated-leftCount of unmated left reads mapped in this location.

    unmated-left

    Count of unmated left reads mapped in this location.

    proper-rightCount of properly paired right reads mapped in this location.

    proper-right

    Count of properly paired right reads mapped in this location.

    discordant-rightCount of discordantly paired right reads mapped in this location.

    discordant-right

    Count of discordantly paired right reads mapped in this location.

    unmated-rightCount of unmated right reads mapped in this location.

    unmated-right

    Count of unmated right reads mapped in this location.

    not-pairedCount of single end reads mapped in this location.

    not-paired

    Count of single end reads mapped in this location.

    uniqueCount of unique mappings in this location.

    unique

    Count of unique mappings in this location.

    ambiguousCount of ambiguous mappings in this location.

    ambiguous

    Count of ambiguous mappings in this location.

    n-countThe number of unknown bases on the reference for this location.

    n-count

    The number of unknown bases on the reference for this location.

    @@ -1584,8 +1499,8 @@

    Discord command output file descriptionsdiscord_pairs.vcf.gz using the ALT and INFO fields as defined in the VCF specification.

    @@ -1710,11 +1625,11 @@

    Coverage command output file descriptions -
  • Chromosome name
  • -
  • Start position in chromosome
  • -
  • End position in chromosome
  • -
  • Name or label of the feature, this is generally the name of the chromosome or name of any BED features overlapping the coverage region
  • -
  • Depth of coverage for the range specified
  • +
  • Chromosome name

  • +
  • Start position in chromosome

  • +
  • End position in chromosome

  • +
  • Name or label of the feature, this is generally the name of the chromosome or name of any BED features overlapping the coverage region

  • +
  • Depth of coverage for the range specified

  • When the --per-region flag is set, the coverage command will alter the criteria for outputting a BED record. Rather than defining regions @@ -1750,10 +1665,10 @@

    Coverage command output file descriptions -
  • Chromosome name
  • -
  • Start position in chromosome
  • -
  • End position in chromosome
  • -
  • Depth of coverage for the range specified
  • +
  • Chromosome name

  • +
  • Start position in chromosome

  • +
  • End position in chromosome

  • +
  • Depth of coverage for the range specified

  • When the --per-base flag is set when running the coverage command will produce a tab separated value file with the coverage information @@ -1776,31 +1691,31 @@

    Coverage command output file descriptions +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    sequenceThe chromosome name.

    sequence

    The chromosome name.

    positionThe position in the reference chromosome.

    position

    The position in the reference chromosome.

    unique-countThe count of reads covering this position with IH equal to one.

    unique-count

    The count of reads covering this position with IH equal to one.

    ambiguous-countThe count of reads covering this position with IH greater than one.

    ambiguous-count

    The count of reads covering this position with IH greater than one.

    scoreThe sum of one divided by the IH value for all the reads covering this position.

    score

    The sum of one divided by the IH value for all the reads covering this position.

    @@ -1822,31 +1737,31 @@

    Coverage command output file descriptions +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    depthThe average depth of coverage for the region where each base position is calculated as the sum of one divided by the IH of each read alignment which covers the position.

    depth

    The average depth of coverage for the region where each base position is calculated as the sum of one divided by the IH of each read alignment which covers the position.

    breadthThe fraction of the non-N region base positions which have a depth of one or greater.

    breadth

    The fraction of the non-N region base positions which have a depth of one or greater.

    coveredThe number of non-N bases in the region which have a depth of one or greater.

    covered

    The number of non-N bases in the region which have a depth of one or greater.

    sizeThe number of non-N bases in the region.

    size

    The number of non-N bases in the region.

    nameThe name of the region, or “all sequences” for the entire reference.

    name

    The name of the region, or “all sequences” for the entire reference.

    @@ -1866,28 +1781,28 @@

    Coverage command output file descriptions +--++ - - - + + + - - - + + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    coverage_levelThe coverage level.

    coverage_level

    The coverage level.

    countThe count of the number of bases at this coverage level.

    count

    The count of the number of bases at this coverage level.

    %ageThe percentage of the reference at this coverage level.

    %age

    The percentage of the reference at this coverage level.

    %cumulativeThe percentage of the reference at this coverage level or higher.

    %cumulative

    The percentage of the reference at this coverage level or higher.

    @@ -1913,83 +1828,83 @@

    Mapx and mapp output file description +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + - - + @@ -2001,32 +1916,32 @@

    Mapx and mapp output file description +

    ColumnDescription

    Column

    Description

    template-nameID or description of protein (reference) with match.

    template-name

    ID or description of protein (reference) with match.

    frameDenotes translation frame on forward (1,2,3) or reverse strand.

    frame

    Denotes translation frame on forward (1,2,3) or reverse strand.

    read-idNumeric ID of query sequence from SDF.

    read-id

    Numeric ID of query sequence from SDF.

    template-startStart position of alignment on protein subject.

    template-start

    Start position of alignment on protein subject.

    template-endEnd position of alignment on protein subject.

    template-end

    End position of alignment on protein subject.

    template-lengthAmino acid length of protein subject.

    template-length

    Amino acid length of protein subject.

    read-startStart position of alignment on query sequence.

    read-start

    Start position of alignment on query sequence.

    read-endEnd position of alignment on query sequence.

    read-end

    End position of alignment on query sequence.

    read-lengthTotal length of query (nucleotides for mapx / amino acids for mapp).

    read-length

    Total length of query (nucleotides for mapx / amino acids for mapp).

    template-proteinAmino acid sequence of aligned protein reference.

    template-protein

    Amino acid sequence of aligned protein reference.

    read-proteinAmino acid sequence of aligned query sequence.

    read-protein

    Amino acid sequence of aligned query sequence.

    alignmentAmino acid alignment of match.

    alignment

    Amino acid alignment of match.

    identicalCount of identities in alignment between protein subject and query sequences.

    identical

    Count of identities in alignment between protein subject and query sequences.

    %identicalPercent identity of match between protein subject and query sequences, for exact matches only (global across query sequence).

    %identical

    Percent identity of match between protein subject and query sequences, for exact matches only (global across query sequence).

    positiveCount of identical and similar amino acids in alignment between protein subject and query sequences.

    positive

    Count of identical and similar amino acids in alignment between protein subject and query sequences.

    %positivePercent similarity between protein subject and query sequences, for exact and similar matches (global across query sequence).

    %positive

    Percent similarity between protein subject and query sequences, for exact and similar matches (global across query sequence).

    mismatchesCount of mismatches between protein subject and query sequences.

    mismatches

    Count of mismatches between protein subject and query sequences.

    raw-scoreRTG alignment score (S); The alignment score is the negated sum of all single protein raw scores plus its penalties for gaps, which is the edit distance using one of the scoring matrices. Note that the RTG alignment score is the negated raw score of BLAST.

    raw-score

    RTG alignment score (S); The alignment score is the negated sum of all single protein raw scores plus its penalties for gaps, which is the edit distance using one of the scoring matrices. Note that the RTG alignment score is the negated raw score of BLAST.

    bit-score

    Bit score is computed from the alignment score using the following formula: -\text{bit-score} = ((\lambda \times -S) - \ln (K)) / \ln (2)

    -

    where \lambda and K are taken from the matrix defaults [Blast pp.302-304] and S is the RTG alignment score.

    +

    bit-score

    Bit score is computed from the alignment score using the following formula: +\text{bit-score} = ((\lambda \times -S) - \ln (K)) / \ln (2)

    +

    where \lambda and K are taken from the matrix defaults [Blast pp.302-304] and S is the RTG alignment score.

    e-score

    e-score is computed from the alignment score using the following formula: -\text{e-score} = K \times m' \times n \times e ^ {(\lambda \times S)}

    -

    n is the total length of the database.

    -

    m' is the effective length of the query (read):

    -

    m' = \max(1, \text{querylength} + \lambda \times S/H)

    +

    e-score

    e-score is computed from the alignment score using the following formula: +\text{e-score} = K \times m' \times n \times e ^ {(\lambda \times S)}

    +

    n is the total length of the database.

    +

    m' is the effective length of the query (read):

    +

    m' = \max(1, \text{querylength} + \lambda \times S/H)

    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + +
    CharacterDescription

    Character

    Description

    dIndicates that after alignment scores are calculated, the remaining hits were discarded because they exceeded the alignment score threshold (affected by ---max-alignment-score).

    d

    Indicates that after alignment scores are calculated, the remaining hits were discarded because they exceeded the alignment score threshold (affected by +--max-alignment-score).

    eIndicates that there were good scoring hits, but the results were discarded because there were too many of these hits (affected by --max-top-results).

    e

    Indicates that there were good scoring hits, but the results were discarded because there were too many of these hits (affected by --max-top-results).

    fIndicates that there was a good hit which failed the percent identity threshold (affected by --min-identity).

    f

    Indicates that there was a good hit which failed the percent identity threshold (affected by --min-identity).

    gIndicates that there was a good hit which failed the e-score threshold (affected by --max-e-score).

    g

    Indicates that there was a good hit which failed the e-score threshold (affected by --max-e-score).

    hIndicates that there was a good hit which failed the bit score threshold (affected by --min-bit-score).

    h

    Indicates that there was a good hit which failed the bit score threshold (affected by --min-bit-score).

    @@ -2064,67 +1979,67 @@

    Species results file description +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    ColumnDescription

    Column

    Description

    abundanceFraction of the individuals in the sample that belong to this taxon. The output file is sorted on this column.

    abundance

    Fraction of the individuals in the sample that belong to this taxon. The output file is sorted on this column.

    abundance-lowLower bound three standard deviations below the abundance.

    abundance-low

    Lower bound three standard deviations below the abundance.

    abundance-highUpper bound three standard deviations above the abundance.

    abundance-high

    Upper bound three standard deviations above the abundance.

    DNA-fractionRaw fraction of the DNA that maps to this taxon.

    DNA-fraction

    Raw fraction of the DNA that maps to this taxon.

    DNA-fraction-lowLower bound three standard deviations below the DNA-fraction.

    DNA-fraction-low

    Lower bound three standard deviations below the DNA-fraction.

    DNA-fraction-highUpper bound three standard deviations above the DNA-fraction.

    DNA-fraction-high

    Upper bound three standard deviations above the DNA-fraction.

    confidenceConfidence that this taxon is present in the sample. (Computed as the number of standard deviations away from the null hypotheses).

    confidence

    Confidence that this taxon is present in the sample. (Computed as the number of standard deviations away from the null hypotheses).

    coverage-depthThe coverage depth of reads mapped to the taxon sequences, adjusted for the IH (number of output alignments) of the individual reads. (Zero if no reference sequences for the taxon).

    coverage-depth

    The coverage depth of reads mapped to the taxon sequences, adjusted for the IH (number of output alignments) of the individual reads. (Zero if no reference sequences for the taxon).

    coverage-breadthThe fraction of the taxon sequences covered by the reads. (Zero if no reference sequences for the taxon).

    coverage-breadth

    The fraction of the taxon sequences covered by the reads. (Zero if no reference sequences for the taxon).

    reference-lengthThe total length of the reference sequences, will be 0 if the taxon does not have associated reference sequences.

    reference-length

    The total length of the reference sequences, will be 0 if the taxon does not have associated reference sequences.

    mapped-readsThe count of the reads which mapped to this taxon, adjusted for the IH (number of output alignments) of the individual reads.

    mapped-reads

    The count of the reads which mapped to this taxon, adjusted for the IH (number of output alignments) of the individual reads.

    has-referenceY if the taxon has associated reference sequences, otherwise N.

    has-reference

    Y if the taxon has associated reference sequences, otherwise N.

    taxa-countThe count of the number of taxa that are descendants of this taxon (including itself) and which are above the minimum confidence threshold.

    taxa-count

    The count of the number of taxa that are descendants of this taxon (including itself) and which are above the minimum confidence threshold.

    taxon-idThe taxonomic ID for this result.

    taxon-id

    The taxonomic ID for this result.

    parent-idThe taxonomic ID of this results parent.

    parent-id

    The taxonomic ID of this results parent.

    rankThe taxonomic rank associated with this result. This can be used to filter results into meaningful sets at different taxonomic ranks.

    rank

    The taxonomic rank associated with this result. This can be used to filter results into meaningful sets at different taxonomic ranks.

    taxonomy-nameThe taxonomic name for this result.

    taxonomy-name

    The taxonomic name for this result.

    @@ -2137,7 +2052,7 @@

    Similarity results file descriptionsclosest.tre and closest.xml).

    The similarity matrix file is a tab separated format file containing an -N\times N matrix of the matching k-mer counts, where N is the number of +N\times N matrix of the matching k-mer counts, where N is the number of samples. An example of a similarity.tsv file:

    #rtg similarity --unique-words -o similarity-out -I samples.txt -w 20 -s 15
     F1_G_S_1M     F1_N_AN_1M      F1_O_BM_1M      F1_O_SP_1M      F1_O_TD_1M      F1_V_PF_1M
    @@ -2191,19 +2106,19 @@ 

    CHROM, POS, ID, REF, QUALWithin the context of a --keep-expr or record function these variables will provide access to the String representation of the VCF column of the same name.

    -
    CHROM; // "1"
    -POS; // "11259340"
    -ID; // "."
    -REF; // "G"
    -QUAL; // "."
    +
    CHROM; // "1"
    +POS; // "11259340"
    +ID; // "."
    +REF; // "G"
    +QUAL; // "."
     

    ALT, FILTER

    Will retrieve an array of the values in the column.

    -
    ALT; // ["C", "T"]
    -FILTER; // ["PASS"]
    +
    ALT; // ["C", "T"]
    +FILTER; // ["PASS"]
     
    @@ -2215,8 +2130,8 @@

    INFO.{INFO_FIELD}.”. Assigning to these properties will update the VCF record. This will be undefined for fields not declared in the header.

    -
    INFO.DP; // "795"
    -INFO.ABC; // "4,5"
    +
    INFO.DP; // "795"
    +INFO.ABC; // "4,5"
     
    @@ -2226,8 +2141,8 @@

    {SAMPLE_NAME}.{FORMAT_FIELD}FORMAT field ID.

    -
    'NA12877'.GT; // "1/2"
    -'NA12878'.GT; // "1/0"
    +
    'NA12877'.GT; // "1/2"
    +'NA12878'.GT; // "1/0"
     

    Note that these properties are only defined for fields that are declared @@ -2241,20 +2156,20 @@

    VCF record modificationMost components of VCF records can be written or updated in a fairly natural manner by direct assignment in order to make modifications. For example:

    -
    CHROM = "chr1";      // Will change the CHROM value
    -POS = 42;            // Will change the POS value
    -ID = "rs23987382";   // Will change the ID value
    -QUAL = "50";         // Will change the QUAL value
    -FILTER = "FAIL";     // Will set the FILTER value
    -INFO.DPR = "0.01";   // Will change the value of the DPR info field
    -'NA12877'.DP = "10"; // Will change the DP field of the NA12877 sample
    +
    CHROM = "chr1";      // Will change the CHROM value
    +POS = 42;            // Will change the POS value
    +ID = "rs23987382";   // Will change the ID value
    +QUAL = "50";         // Will change the QUAL value
    +FILTER = "FAIL";     // Will set the FILTER value
    +INFO.DPR = "0.01";   // Will change the value of the DPR info field
    +'NA12877'.DP = "10"; // Will change the DP field of the NA12877 sample
     

    Other components of the VCF record (such as REF, and ALT) are considered immutable and can not currently be altered.

    -

    Note

    -

    Modification of CHROM and/or POS can lead to a VCF file +

    Note

    +

    Modification of CHROM and/or POS can lead to a VCF file which is incorrectly sorted and this will not necessarily be detected or reported until the resulting VCF file is used with another module or tool. Depending on the new value assigned to CHROM it may @@ -2263,10 +2178,10 @@

    VCF record modification

    Direct assignment to ID and FILTER fields accept either a string containing semicolon separated values, or a list of values. For example:

    -
    ID = 'rs23987382;COSM3805';
    -ID = ['rs23987382', 'COSM3805'];
    -FILTER = 'BAZ;BANG';
    -FILTER = ['BAZ', 'BANG'];
    +
    ID = 'rs23987382;COSM3805';
    +ID = ['rs23987382', 'COSM3805'];
    +FILTER = 'BAZ;BANG';
    +FILTER = ['BAZ', 'BANG'];
     

    Note that although the FILTER field returns an array when read, any @@ -2275,16 +2190,16 @@

    VCF record modificationAdding a filter to existing filters is a common operation and can be accomplished by the above assignment methods, for example by adding a value to the existing list and then setting the result:

    -
    var f = FILTER;
    -f.push('BOING');
    -FILTER = f;
    +
    var f = FILTER;
    +f.push('BOING');
    +FILTER = f;
     

    However, since this is a little unwieldy, a convenience function called add() can be used (and may be chained):

    -
    FILTER.add('BOING');
    -FILTER.add(['BOING', 'DOING');
    -FILTER.add('BOING').add('DOING');
    +
    FILTER.add('BOING');
    +FILTER.add(['BOING', 'DOING');
    +FILTER.add('BOING').add('DOING');
     
    @@ -2295,31 +2210,80 @@

    VCF header modification--javascript.

    -

    ensureFormatHeader(FORMAT_HEADER_STRING)

    +

    ensureFormatHeader({FORMAT_HEADER_STRING})

    Add a new FORMAT field to the VCF if it is not already present. This will add a FORMAT declaration line to the header and define the corresponding accessor methods for use in record processing.

    -
    ensureFormatHeader('##FORMAT=<ID=GL,Number=G,Type=Float,' +
    -  'Description="Log_10 scaled genotype likelihoods.">');
    +
    ensureFormatHeader('##FORMAT=<ID=GL,Number=G,Type=Float,' +
    +  'Description="Log_10 scaled genotype likelihoods.">');
     
    -

    ensureInfoHeader(INFO_HEADER_STRING)

    +

    ensureInfoHeader({INFO_HEADER_STRING})

    Add a new INFO field to the VCF if it is not already present. This will add an INFO declaration line to the header and define the corresponding accessor methods for use in record processing.

    -
    ensureInfoHeader('##INFO=<ID=CT,Number=1,Type=Integer,' +
    -  'Description="Coverage threshold that was applied">');
    +
    ensureInfoHeader('##INFO=<ID=CT,Number=1,Type=Integer,' +
    +  'Description="Coverage threshold that was applied">');
     
    -

    ensureFilterHeader(FILTER_HEADER_STRING)

    +

    ensureFilterHeader({FILTER_HEADER_STRING})

    Add a new FILTER field to the VCF header if it is not already present. This will add an FILTER declaration line to the header.

    -
    ensureFilterHeader('##INFO=<ID=FAIL_VAL,' +
    -  'Description="Failed validation">');
    +
    ensureFilterHeader('##INFO=<ID=FAIL_VAL,' +
    +  'Description="Failed validation">');
    +
    +
    +
    +
    +
    +

    Testing for overlap with genomic regions

    +

    One common use case is to test whether any given VCF record overlaps or +is contained within a set of genomic regions. Regions may be loaded from +either an external BED file or VCF file in the run-once portion of the +JavaScript by either of the following:

    +
    +

    Regions.fromBed({FILENAME})

    +

    Load the specified BED file into a regions object. For example:

    +
    var myregions = Regions.fromBed('/path/to/regions.bed');
    +
    +
    +
    +
    +

    Regions.fromVcf({FILENAME})

    +

    Load the specified VCF file into a regions object. For example:

    +
    var myregions = Regions.fromVcf('/path/to/regions.vcf');
    +
    +
    +

    Having loaded a set of genomic regions, this can be used to test for +region overlaps using the following methods:

    +
    +
    +

    {REGIONS_OBJECT}.overlaps({CHROM}, {START}, {END})

    +

    Return true if the loaded regions overlap the specified interval. This +function is typically used within the record function to test the +coordinates of the current VCF record, e.g.:

    +
    function record() {
    +    if (myregions.overlaps(CHROM, POS, POS + REF.length)) {
    +        // do something if the record overlaps any region
    +    }
    +}
    +
    +
    +
    +
    +

    {REGIONS_OBJECT}.encloses({CHROM}, {START}, {END})

    +

    Return true if the loaded regions entirely encloses the supplied +interval. This function is typically used within the record +function to test the coordinates of the current VCF record, e.g.:

    +
    function record() {
    +    if (myregions.encloses(CHROM, POS, POS + REF.length)) {
    +        // do something if the record is fully enclosed by any region
    +    }
    +}
     
    @@ -2329,36 +2293,36 @@

    Additional information and functions

    SAMPLES

    This variable contains an array of the sample names in the VCF header.

    -
    SAMPLES; // ['NA12877', 'NA12878']
    +
    SAMPLES; // ['NA12877', 'NA12878']
     
    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/genindex.html b/installer/resources/core/RTGOperationsManual/genindex.html index 9342e5989..e37ccc181 100644 --- a/installer/resources/core/RTGOperationsManual/genindex.html +++ b/installer/resources/core/RTGOperationsManual/genindex.html @@ -1,27 +1,26 @@ - - + - - - Index — RTG Core Operations Manual v3.11 + + + Index — RTG Core Operations Manual v3.12 - - - - - - + + + + + + - +
    @@ -54,9 +47,17 @@

    Index

    +

    +
    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/index.html b/installer/resources/core/RTGOperationsManual/index.html index fa9e4f947..3aa235bfe 100644 --- a/installer/resources/core/RTGOperationsManual/index.html +++ b/installer/resources/core/RTGOperationsManual/index.html @@ -2,26 +2,26 @@ - + - - - Table Of Contents — RTG Core Operations Manual v3.11 + + + Table Of Contents — RTG Core Operations Manual v3.12 - - - - - - + + + + + + - +
    +

    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/objects.inv b/installer/resources/core/RTGOperationsManual/objects.inv index 75a7108d7..81a152b11 100644 Binary files a/installer/resources/core/RTGOperationsManual/objects.inv and b/installer/resources/core/RTGOperationsManual/objects.inv differ diff --git a/installer/resources/core/RTGOperationsManual/overview.html b/installer/resources/core/RTGOperationsManual/overview.html index f8831bb30..185425e67 100644 --- a/installer/resources/core/RTGOperationsManual/overview.html +++ b/installer/resources/core/RTGOperationsManual/overview.html @@ -2,27 +2,27 @@ - + - - - Overview — RTG Core Operations Manual v3.11 + + + Overview — RTG Core Operations Manual v3.12 - - - - - - + + + + + + - +
    @@ -138,27 +71,27 @@

    Introduction -
  • Medical Genomic Research – Compare sequence variants and +
  • Medical Genomic Research – Compare sequence variants and structural variation between normal and disease genomes, or over a -disease progression in the same individual to identity causal loci.

  • -
  • Personalized Medicine – Establish reliable, high-throughput +disease progression in the same individual to identity causal loci.

  • +
  • Personalized Medicine – Establish reliable, high-throughput processing pipelines that analyze individual human genomes compared to one or more reference genomes. Use RTG software for detection of sequence variants (SNP and indel calling, intersection scripting), as well as structural variation (coverage depth, and copy number -variation).

  • -
  • Model Organisms and Basic Research – Utilize RTG mapping and +variation).

  • +
  • Model Organisms and Basic Research – Utilize RTG mapping and variant detection commands for focused research applications such as metagenomic species identification and frequency, and metabolic pathway analysis. Map microbial communities to generate gapped -alignments of both DNA and protein sequence data.

  • -
  • Plant Genomics – Enable investigations of new crop species and +alignments of both DNA and protein sequence data.

  • +
  • Plant Genomics – Enable investigations of new crop species and variant detection in genetically diverse strains by leveraging RTG’s highly sensitive sequence search capabilities for strain and cross-species mapping applications. Flexible sensitivity tuning controls allow investigators to accommodate very high error rates associated with unique combinations of sequencing system error, -genome-specific mutation, and aggressive cross-species comparisons.

  • +genome-specific mutation, and aggressive cross-species comparisons.

    @@ -173,33 +106,33 @@

    RTG software description -
  • Sequence Search and Alignment – RTG software uses patented +
  • Sequence Search and Alignment – RTG software uses patented sequence search technology for the rapid production of genomic sequence data. The map command implements read mapping and gapped alignment of sequence data against a reference. The mapx command -searches translated sequence data against a protein database.

  • -
  • Data Analysis – RTG software supports two pipelines for data +searches translated sequence data against a protein database.

  • +
  • Data Analysis – RTG software supports two pipelines for data analysis - variant detection and metagenomics. Purpose-built variant detection pipeline functions include several commands to identify small sequence variants, a cnv command to report copy number variation statistics for structural variation, and a coverage -command to report read depth across a reference.

  • -
  • Reporting Options – Standard result formats and utility commands +command to report read depth across a reference.

  • +
  • Reporting Options – Standard result formats and utility commands report results for validation, and ease development of custom scripts for analysis. Scripts that produce publication quality graphics for visualization of data analysis results are available through Real -Time Genomics technical support.

  • -
  • Data Center Deployment – RTG software supports typical data +Time Genomics technical support.

  • +
  • Data Center Deployment – RTG software supports typical data center standards for enterprise deployment. RTG provides automated installation and supports industry standard operating environments and data processing systems to help maintain total cost of ownership objectives in enterprise data centers. The RTG software can be run in compute clusters of varying sizes, and commands take advantage of -multi-core processors by default.

  • +multi-core processors by default.

    @@ -215,32 +148,32 @@

    Sequence search and alignment -
  • Read mapping by nucleotide sequence alignment to a reference genome
  • -
  • Protein database searching by translated nucleotide sequence searches -against protein databases
  • -
  • Sensitivity tuning using parameter options for substitutions, indels, -indel lengths, word or step sizes, and alignment scores
  • -
  • Filtering and reporting ambiguous reads that map to multiple -locations
  • -
  • Benchmarking and optimization using simulation and evaluation -commands
  • +
  • Read mapping by nucleotide sequence alignment to a reference genome

  • +
  • Protein database searching by translated nucleotide sequence searches +against protein databases

  • +
  • Sensitivity tuning using parameter options for substitutions, indels, +indel lengths, word or step sizes, and alignment scores

  • +
  • Filtering and reporting ambiguous reads that map to multiple +locations

  • +
  • Benchmarking and optimization using simulation and evaluation +commands

  • RTG mapping commands have the following characteristics:

      -
    • Eliminates need for genome indexing
    • -
    • Aligns sequence reads of any length
    • -
    • Allows high mismatch levels for increased sensitivity in longer reads
    • -
    • Allows detection of short indels with single end (SE) or paired end -(PE) data
    • -
    • Can optionally guarantee the mapping of reads with at least a -specified number of substitutions and indels
    • -
    • Supports a wide range of alignment scores
    • +
    • Eliminates need for genome indexing

    • +
    • Aligns sequence reads of any length

    • +
    • Allows high mismatch levels for increased sensitivity in longer reads

    • +
    • Allows detection of short indels with single end (SE) or paired end +(PE) data

    • +
    • Can optionally guarantee the mapping of reads with at least a +specified number of substitutions and indels

    • +
    • Supports a wide range of alignment scores

    -

    See also

    +

    See also

    For detailed information about sequence search and alignment functionality, refer to Command Reference, map.

    -

    For more information about the RTG integrated software pipeline, refer to RTG product usage - baseline progressions

    +

    For more information about the RTG integrated software pipeline, refer to RTG product usage - baseline progressions

    @@ -336,10 +269,10 @@

    Read mapping output filesXC attributes in the BAM file that describe why a read did not map.

    -

    See also

    +

    See also

    For more information about the RTG map command, refer to Command Reference, map.

    -

    For details on RTG extensions to the BAM file format, refer to SAM/BAM file extensions (RTG map command output)

    +

    For details on RTG extensions to the BAM file format, refer to SAM/BAM file extensions (RTG map command output)

    @@ -398,8 +331,8 @@

    Protein search -

    See also

    -

    For more information about the RTG protein mapping commands +

    See also

    +

    For more information about the RTG protein mapping commands please refer to Command Reference, mapx and Command Reference, mapp

    @@ -417,8 +350,8 @@

    Protein search output files -

    See also

    -

    For detailed information about the RTG mapx and +

    See also

    +

    For detailed information about the RTG mapx and mapp command results file format refer to Mapx and mapp output file description

    @@ -435,8 +368,8 @@

    Protein search sensitivity tuning -

    See also

    -

    For more information about the RTG mapx command’s +

    See also

    +

    For more information about the RTG mapx command’s sensitivity and tuning parameters, refer to Mapx and mapp output file description

    @@ -449,28 +382,28 @@

    Benchmarking and optimization utilities -
  • genomesim +
  • genomesim The genomesim command generates a reference genome with one or more segments of varying length and a percentage mix of nucleotide values. Use the command to create simulated genomes for benchmarking and -evaluation.

  • -
  • readsim / cgsim +evaluation.

  • +
  • readsim / cgsim The readsim / cgsim commands generate synthetic read sequence data from an input reference genome, introducing errors at a specified rate. Use the commands to create simulated read sets for -benchmarking and evaluation.

  • -
  • popsim, samplesim, childsim, samplereplay, denovosim +benchmarking and evaluation.

  • +
  • popsim, samplesim, childsim, samplereplay, denovosim These variant simulation commands are used to create mutated genomes from a known reference by adding variants. Use these commands to verify accuracy of variant detection analysis software for a -particular experiment using different pipeline settings.

  • +particular experiment using different pipeline settings.

    Simulated data that is produced in SDF format can be converted into FASTA and FASTQ format sequence files for use with other tools using the sdf2fasta and sdf2fastq commands respectively.

    @@ -609,8 +542,8 @@

    Copy number variation (CNV) analysisgnuplot.

    @@ -620,40 +553,40 @@

    Standard input and output file formats +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + +
    File typeDescription and Usage

    File type

    Description and Usage

    BAM, SAMThe RTG map and cgmap commands produces alignment results in the Binary Sequence Alignment/Map (BAM) format: alignments.bam or optionally the compressed ASCII (SAM format) equivalent alignments.sam.gz. This allows use of familiar pileup viewers for quick visual inspection of alignment results.

    BAM, SAM

    The RTG map and cgmap commands produces alignment results in the Binary Sequence Alignment/Map (BAM) format: alignments.bam or optionally the compressed ASCII (SAM format) equivalent alignments.sam.gz. This allows use of familiar pileup viewers for quick visual inspection of alignment results.

    TXTMany RTG commands output summary statistics as ASCII text files.

    TXT

    Many RTG commands output summary statistics as ASCII text files.

    TSVMany RTG commands output results in tab separated ASCII text files. These files can typically be loaded directly into a spreadsheet viewing program like Microsoft Excel or Open Office.

    TSV

    Many RTG commands output results in tab separated ASCII text files. These files can typically be loaded directly into a spreadsheet viewing program like Microsoft Excel or Open Office.

    BEDSome RTG commands output results in standard BED formats for further analysis and reporting.

    BED

    Some RTG commands output results in standard BED formats for further analysis and reporting.

    PEDSome RTG commands utilize standard PED format text files for supplying sample pedigree and sex information.

    PED

    Some RTG commands utilize standard PED format text files for supplying sample pedigree and sex information.

    VCFThe snp, family, population and somatic commands output results in Variant Call Format (VCF) version 4.1.

    VCF

    The snp, family, population and somatic commands output results in Variant Call Format (VCF) version 4.1.

    @@ -668,8 +601,8 @@

    SAM/BAM files created by the RTG map commandmap aligner.

    @@ -758,10 +691,10 @@

    Pipelines -
  • species composition (composition-meta-pipeline)
  • -
  • functional protein analysis (functional-meta-pipeline)
  • -
  • species composition and functional protein analysis -(composition-functional-meta-pipeline).
  • +
  • species composition (composition-meta-pipeline)

  • +
  • functional protein analysis (functional-meta-pipeline)

  • +
  • species composition and functional protein analysis +(composition-functional-meta-pipeline).

  • For detailed information about individual pipeline commands see Pipeline Commands

    @@ -782,8 +715,8 @@

    Parallel processing--region or --bed-regions parameter to allow breaking up tasks into pieces across the reference genome.

    -

    See also

    -

    See RTG Command Reference +

    See also

    +

    See RTG Command Reference for command-specific details, Administration & Capacity Planning for detailed information about estimating the number of multi-core servers needed (capacity planning), and Parallel processing approach for a @@ -804,20 +737,20 @@

    Installation and deployment +--++ - - - + + + - - + + - - + +
    ProcessorIntel Core i7-2600

    Processor

    Intel Core i7-2600

    Memory48 GB RAM DDR3

    Memory

    48 GB RAM DDR3

    Disk5 TB, 7200 RPM (prefer SAS disk)

    Disk

    5 TB, 7200 RPM (prefer SAS disk)

    @@ -847,19 +780,16 @@

    Quick start instructionsUnzip the RTG distribution to the desired location.

    - -
  • If your installation requires a license file (rtg-license.txt), +

  • Unzip the RTG distribution to the desired location.

  • +
  • If your installation requires a license file (rtg-license.txt), copy the license file provided by Real Time Genomics into the RTG -distribution directory.

    -
  • -
  • -
    In a terminal, cd to the installation directory and test for success
    -

    by entering ./rtg version

    +distribution directory.

  • +
  • +
    In a terminal, cd to the installation directory and test for success

    by entering ./rtg version

  • -
  • On MacOS X, depending on your operating system version and +

  • On MacOS X, depending on your operating system version and configuration regarding unsigned applications, you may encounter the error message:

  • -
  • Enter ./rtg help for a list of rtg commands. Help for any +

  • The first time rtg is executed you will be prompted with some +questions to customize your installation. Follow the prompts.

  • +
  • Enter ./rtg help for a list of rtg commands. Help for any individual command is available using the --help flag, e.g.: -./rtg format --help

    -
  • -
  • By default, RTG software scripts establish a memory space of 90% of +./rtg format --help

  • +
  • By default, RTG software scripts establish a memory space of 90% of the available RAM - this is automatically calculated. One may override this limit in the rtg.cfg settings file or on a per-run basis by supplying RTG_MEM as an environment variable or as the -first program argument, e.g.: ./rtg RTG_MEM=48g map

    -
  • -
  • [OPTIONAL] If you will be running RTG on multiple machines and would +first program argument, e.g.: ./rtg RTG_MEM=48g map

  • +
  • [OPTIONAL] If you will be running RTG on multiple machines and would like to customize settings on a per-machine basis, copy rtg.cfg to /etc/rtg.cfg, editing per-machine settings appropriately (requires root privileges). An alternative that does not require root privileges is to copy rtg.cfg to rtg.HOSTNAME.cfg, editing per-machine settings appropriately, where HOSTNAME is the short host -name output by the command hostname -s

    -
  • +name output by the command hostname -s

    Windows:

      -
    • Unzip the RTG distribution to the desired location.
    • -
    • If your installation requires a license, copy the license file +
    • Unzip the RTG distribution to the desired location.

    • +
    • If your installation requires a license, copy the license file provided by Real Time Genomics (rtg-license.txt) into the RTG -distribution directory.

    • -
    • Test for success by entering rtg version at the command line. The +distribution directory.

    • +
    • Test for success by entering rtg version at the command line. The first time RTG is executed you will be prompted with some questions -to customize your installation. Follow the prompts.

    • -
    • Enter rtg help for a list of rtg commands. Help for any +to customize your installation. Follow the prompts.

    • +
    • Enter rtg help for a list of rtg commands. Help for any individual command is available using the --help flag, e.g.: -./rtg format --help

    • -
    • By default, RTG software scripts establish a memory space of 90% of +./rtg format --help

    • +
    • By default, RTG software scripts establish a memory space of 90% of the available RAM - this is automatically calculated. One may override this limit by setting the RTG_MEM variable in the -rtg.bat script or as an environment variable.

    • +rtg.bat script or as an environment variable.

    @@ -944,9 +870,78 @@

    Technical assistance and support

    +

    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/product_usage.html b/installer/resources/core/RTGOperationsManual/product_usage.html index c9c8f238f..ad425fd92 100644 --- a/installer/resources/core/RTGOperationsManual/product_usage.html +++ b/installer/resources/core/RTGOperationsManual/product_usage.html @@ -2,27 +2,27 @@ - + - - - RTG product usage - baseline progressions — RTG Core Operations Manual v3.11 + + + RTG product usage - baseline progressions — RTG Core Operations Manual v3.12 - - - - - - + + + + + + - +
    @@ -191,64 +92,64 @@

    Human read mapping and sequence variant detectionhttp://www.completegenomics.com/public-data/69-Genomes/

    Table : Overview of basic pipeline stages

    - +
    ----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Format reference datartg formatConvert reference sequence from FASTA files to RTG Sequence Data Format (SDF)

    1

    Format reference data

    rtg format

    Convert reference sequence from FASTA files to RTG Sequence Data Format (SDF)

    2Prepare pedigree/sex informationrtg pedstatsConfigure per-sample sex and pedigree relationship information in a PED file

    2

    Prepare pedigree/sex information

    rtg pedstats

    Configure per-sample sex and pedigree relationship information in a PED file

    3Format read datartg format, rtg cg2sdfConvert read sequence from FASTA or FASTQ files to RTG Sequence Data Format (SDF)

    3

    Format read data

    rtg format, rtg cg2sdf

    Convert read sequence from FASTA or FASTQ files to RTG Sequence Data Format (SDF)

    4Map reads against a reference genomertg map, rtg cgmapGenerate read alignments against a given reference, and report in a BAM file for downstream analysis

    4

    Map reads against a reference genome

    rtg map, rtg cgmap

    Generate read alignments against a given reference, and report in a BAM file for downstream analysis

    5View alignment resultsrtg samstatsEvaluate alignments and determine if the mapping should be repeated with different settings

    5

    View alignment results

    rtg samstats

    Evaluate alignments and determine if the mapping should be repeated with different settings

    6Generate coverage informationrtg coverageRun the coverage command to generate coverage breadth and depth statistics

    6

    Generate coverage information

    rtg coverage

    Run the coverage command to generate coverage breadth and depth statistics

    7Call sequence variants (single sample)rtg snpDetect SNPs, MNPs, and indels in a sample relative to a reference genome

    7

    Call sequence variants (single sample)

    rtg snp

    Detect SNPs, MNPs, and indels in a sample relative to a reference genome

    8Call sequence variants (single family)rtg familyPerform sex-aware joint variant calls relative to the reference on a Mendelian family

    8

    Call sequence variants (single family)

    rtg family

    Perform sex-aware joint variant calls relative to the reference on a Mendelian family

    9Call sequence variants (population)rtg populationPerform sex-aware joint variant calls relative to the reference on a population

    9

    Call sequence variants (population)

    rtg population

    Perform sex-aware joint variant calls relative to the reference on a population

    @@ -309,8 +210,8 @@

    Task 1 - Format reference data -

    Note

    -

    When formatting a reference genome, the format command +

    Note

    +

    When formatting a reference genome, the format command will automatically recognize several common human reference genomes and install a reference.txt configuration file. For reference genomes which are not recognized, you should copy or create an @@ -509,21 +410,21 @@

    Task 3 - Format read data -
  • Pre-formatting requires an extra one-off workflow step (the format +
  • Pre-formatting requires an extra one-off workflow step (the format command), whereas native input file formats are directly accepted by -many RTG commands.

  • -
  • Pre-formatting requires extra disk space for the SDF (although these -can be deleted after processing if required).
  • -
  • With pre-formatting, decompression, parsing and error checking raw +many RTG commands.

  • +
  • Pre-formatting requires extra disk space for the SDF (although these +can be deleted after processing if required).

  • +
  • With pre-formatting, decompression, parsing and error checking raw files is carried out only once, whereas native formats require this -processing each time.

  • -
  • Pre-formatting permits random access to individual sequences or +processing each time.

  • +
  • Pre-formatting permits random access to individual sequences or blocks of sequences, whereas with native formats, the whole file leading up to the region of interest must also be decompressed, and -parsed.

  • -
  • Pre-formatting permits loading of sequence data, sequence names, and +parsed.

  • +
  • Pre-formatting permits loading of sequence data, sequence names, and sequence quality values independently, allowing reduced RAM use -during mapping

  • +during mapping

    Thus, pre-formatting read sequence data can result in lower overall resource requirements (and faster throughput) than processing native @@ -676,8 +577,8 @@

    Task 4 - Map reads to the reference genome -

    Note

    -

    The exome capture BED file must correspond to the correct +

    Note

    +

    The exome capture BED file must correspond to the correct reference you are mapping and calling against. You may need to run the BED file supplied by your sequencing vendor through a lift-over tool if the reference genome versions differ.

    @@ -935,8 +836,8 @@

    Task 7 - Call sequence variants (single sample)--mother, --father, --daughter and --son.

    -

    Note

    -

    The RTG family command only supports a basic +

    Note

    +

    The RTG family command only supports a basic family relationship of a mother, father and one or more children, either daughters or sons. For other pedigrees, use the population command.

    @@ -958,8 +859,8 @@

    Task 7 - Call sequence variants (single sample)Small-variant VCF output file description

    -

    Note

    -

    Per-family relationship information can also be specified +

    Note

    +

    Per-family relationship information can also be specified using a pedigree PED file with the --pedigree flag. In this case, the pedigree file should contain a single family only.

    @@ -1004,39 +905,39 @@

    Create and use population priors in variant callingData

    For this use case it is assumed that the following data is available:

      -
    • /data/runs/20humans.vcf.gz - output from a previous population -command run on 20 humans from a population.
    • -
    • /data/reference/human_reference - SDF containing the human -reference sequences.
    • -
    • /data/mappings/new_human.txt - text file containing a list of BAM +
    • /data/runs/20humans.vcf.gz - output from a previous population +command run on 20 humans from a population.

    • +
    • /data/reference/human_reference - SDF containing the human +reference sequences.

    • +
    • /data/mappings/new_human.txt - text file containing a list of BAM files with the sequence alignments for the new member of the -population.

    • +population.

    Table : Overview of pipeline tasks.

    - +
    ----++++ - - - - + + + + - - - - - + + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Produce population priors filertg vcfannotate, -rtg vcfsubsetProduce a reusable set of population priors from an existing VCF file

    1

    Produce population priors file

    rtg vcfannotate, +rtg vcfsubset

    Produce a reusable set of population priors from an existing VCF file

    2Run variant calling using population priorsrtg snpPerform variant calling on the new member of the population using the new population priors to improve results

    2

    Run variant calling using population priors

    rtg snp

    Perform variant calling on the new member of the population using the new population priors to improve results

    @@ -1092,39 +993,39 @@

    Somatic variant detection in cancer +----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Format reference datartg formatConvert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    1

    Format reference data

    rtg format

    Convert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    2Format read datartg formatConvert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    2

    Format read data

    rtg format

    Convert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    3Map reads against the reference genomertg mapGenerate read alignments for the sample(s), and report in a BAM file for downstream analysis

    3

    Map reads against the reference genome

    rtg map

    Generate read alignments for the sample(s), and report in a BAM file for downstream analysis

    4Call somatic variantsrtg somaticDetect somatic variants in the tumor sample

    4

    Call somatic variants

    rtg somatic

    Detect somatic variants in the tumor sample

    @@ -1194,9 +1095,9 @@

    Task 4 - Call somatic variants--original and --derived flags respectively.

    -
    -
    $ rtg somatic -t grch38 -o somatic_out –contamination 0.3
    -
    –derived sm_tumor –original sm_normal normal_map_*/alignments.bam tumor_map_*/alignments.bam
    +
    +
    $ rtg somatic -t grch38 -o somatic_out –contamination 0.3

    –derived sm_tumor –original sm_normal normal_map_*/alignments.bam tumor_map_*/alignments.bam

    +

    Examining the snps.vcf.gz file in the output directory will show a @@ -1372,43 +1273,43 @@

    AVR scoring using HAPMAP for model building/data/runs/NA12878trio/family.vcf.gz.

    Table : Overview of basic pipeline tasks.

    - +
    ----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - + + - +rtg population

    + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Create training datartg vcffilterTo generate positive and negative examples for the AVR machine learning model to train on

    1

    Create training data

    rtg vcffilter

    To generate positive and negative examples for the AVR machine learning model to train on

    2Build and check AVR modelrtg avrbuild, -rtg avrstatsTo create and check an AVR model

    2

    Build and check AVR model

    rtg avrbuild, +rtg avrstats

    To create and check an AVR model

    3Use AVR modelrtg avrpredict, +

    3

    Use AVR model

    rtg avrpredict, rtg snp, rtg family, -rtg population

    To apply the AVR model to the existing output or to use it directly during variant calling

    To apply the AVR model to the existing output or to use it directly during variant calling

    4Install AVR modelcpInstall model in standard RTG model location for later reuse

    4

    Install AVR model

    cp

    Install model in standard RTG model location for later reuse

    @@ -1554,30 +1455,30 @@

    Task 4 - Install AVR model -
  • illumina-exome.avr - model built from Illumina exome sequencing +
  • illumina-exome.avr - model built from Illumina exome sequencing data. If you are running variant calling Illumina exome data you may want to use this model instead of the default, although the -default should still be effective.

  • -
  • illumina-wgs.avr - model built from Illumina whole genome +default should still be effective.

  • +
  • illumina-wgs.avr - model built from Illumina whole genome sequencing data. This model is the default model when running normal -variant calling.

  • -
  • -
    illumina-somatic.avr - model built from somatic samples using
    -
    Illumina sequencing. It is applicable to somatic variant calling, +variant calling.

  • +
  • +
    illumina-somatic.avr - model built from somatic samples using

    Illumina sequencing. It is applicable to somatic variant calling, where a variety of allelic fractions are to be expected in somatic variants. The somatic command defaults to this AVR model. If you want to score germline variants in a somatic run, it is preferable to use illumina-wgs.avr or illumina-exome.wgs -instead.

    +instead.

    +
  • -
  • alternate.avr - model built using XRX, ZY and GQD attributes. +
  • alternate.avr - model built using XRX, ZY and GQD attributes. This should be platform independent and may be a better choice if a more specific model for your data is unavailable. In particular, this model may be more appropriate for scoring the results of variant calling in situations where unusual allele-balance is expected (for example somatic calling with contamination, or calling high -amplification data where allele drop out is expected)

  • +amplification data where allele drop out is expected)

    It is possible to score a sample with more than one AVR model, by running avrpredict with another model and using a different field name @@ -1601,39 +1502,39 @@

    RTG structural variant detectionILLUMINA (for Illumina reads) or COMPLETE (for Complete Genomics reads).

    Table : Overview of structural variants analysis pipeline tasks.

    - +
    ----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Prepare read group statistics filefindIdentify read group statistics files created during mapping

    1

    Prepare read group statistics file

    find

    Identify read group statistics files created during mapping

    2Find structural variants with svrtg svProcess prepared mapping results to identify likely structural variants

    2

    Find structural variants with sv

    rtg sv

    Process prepared mapping results to identify likely structural variants

    3Find structural variants with discordrtg discordProcess prepared mapping results to identify likely structural variant breakends

    3

    Find structural variants with discord

    rtg discord

    Process prepared mapping results to identify likely structural variant breakends

    4Find copy number variantsrtg cnvDetect copy number variants between a pair of samples

    4

    Find copy number variants

    rtg cnv

    Detect copy number variants between a pair of samples

    @@ -1673,43 +1574,43 @@

    Task 2 - Find structural variants with sv +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    HypothesisSemantics

    Hypothesis

    Semantics

    normalNormal mappings, no structural variants

    normal

    Normal mappings, no structural variants

    duplicateAbove normal mappings, potential duplication region

    duplicate

    Above normal mappings, potential duplication region

    deleteBelow normal mappings, potential deletion region

    delete

    Below normal mappings, potential deletion region

    delete-leftMapping data suggest the left breakpoint of a deletion

    delete-left

    Mapping data suggest the left breakpoint of a deletion

    delete-rightMapping data suggest the right breakpoint of a deletion

    delete-right

    Mapping data suggest the right breakpoint of a deletion

    duplicate-leftMapping data suggest the left boundary of a region that has been copied elsewhere

    duplicate-left

    Mapping data suggest the left boundary of a region that has been copied elsewhere

    duplicate-rightMapping data suggest the right boundary of a region that has been copied elsewhere

    duplicate-right

    Mapping data suggest the right boundary of a region that has been copied elsewhere

    breakpointMapping data suggest this location has received an insertion of copied genome

    breakpoint

    Mapping data suggest this location has received an insertion of copied genome

    novel-insertionMapping data suggests this location has received an insertion of material not present in the reference

    novel-insertion

    Mapping data suggests this location has received an insertion of material not present in the reference

    @@ -1788,39 +1689,39 @@

    Ion Torrent bacterial mapping and sequence variant detectionhttp://lifetech-it.hosted.jivesoftware.com, requires registration).

    Table : Overview of basic pipeline tasks.

    - +
    ----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Format reference datartg formatConvert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    1

    Format reference data

    rtg format

    Convert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    2Format read datartg formatConvert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    2

    Format read data

    rtg format

    Convert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    3Map reads against the reference genomertg mapGenerate read alignments for the normal and cancer samples, and report in a BAM file for downstream analysis

    3

    Map reads against the reference genome

    rtg map

    Generate read alignments for the normal and cancer samples, and report in a BAM file for downstream analysis

    4Call sequence variants in haploid modertg snpDetect SNPs, MNPs, and indels in haploid sample relative to the reference genome

    4

    Call sequence variants in haploid mode

    rtg snp

    Detect SNPs, MNPs, and indels in haploid sample relative to the reference genome

    @@ -1900,39 +1801,39 @@

    RTG contaminant filtering +----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Format reference datartg formatConvert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    1

    Format reference data

    rtg format

    Convert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    2Format read datartg formatConvert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    2

    Format read data

    rtg format

    Convert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    3Run contamination filterrtg mapfProduce the SDF file of reads which map to the contaminant and the SDF file of those that do not

    3

    Run contamination filter

    rtg mapf

    Produce the SDF file of reads which map to the contaminant and the SDF file of those that do not

    4Manage filtered readsmvSet up the results for use in further processing

    4

    Manage filtered reads

    mv

    Set up the results for use in further processing

    @@ -2105,34 +2006,34 @@

    RTG translated protein searchingnr.fasta and the human gut sample is called human-gut.fastq.

    Table : Overview of translated protein searching tasks.

    - +
    ----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Format protein data setrtg formatConvert protein data set from FASTA to RTG sequence data format (SDF)

    1

    Format protein data set

    rtg format

    Convert protein data set from FASTA to RTG sequence data format (SDF)

    2Format DNA read setrtg formatConvert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    2

    Format DNA read set

    rtg format

    Convert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    3Search against protein data setrtg mapxGenerate search results with alignments in tabular format

    3

    Search against protein data set

    rtg mapx

    Generate search results with alignments in tabular format

    @@ -2187,44 +2088,44 @@

    RTG species frequency estimation +----++++ - - - - + + + + - - - - - + + + + + - - - - + + + + - - - - + + + + - - - - + + + + - - - - + + + +
    TaskCommand & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Format reference datartg formatConvert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    1

    Format reference data

    rtg format

    Convert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    2Format read datartg formatConvert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    2

    Format read data

    rtg format

    Convert read sequence from FASTA and FASTQ files to RTG Sequence Data Format (SDF)

    3Run contamination filter (optional)rtg mapfProduce the SDF file of reads which map to the contaminant and the SDF file of those that do not

    3

    Run contamination filter (optional)

    rtg mapf

    Produce the SDF file of reads which map to the contaminant and the SDF file of those that do not

    4Map metagenomic reads against bacterial databasertg mapGenerate read alignments against a given reference, and report in a BAM file for downstream analysis

    4

    Map metagenomic reads against bacterial database

    rtg map

    Generate read alignments against a given reference, and report in a BAM file for downstream analysis

    5Run species estimatorrtg speciesProduce a text file which contains a list of species, one per line, with an estimate of the relative frequency in the sample

    5

    Run species estimator

    rtg species

    Produce a text file which contains a list of species, one per line, with an estimate of the relative frequency in the sample

    @@ -2340,35 +2241,35 @@

    RTG sample similarityk-mer word frequencies and the intersections between sets of reads.

    Table : Overview of sample similarity tasks.

    - +
    ----++++ - - - - - + + + + + - - - - - + + + + + - - - - + + + + - - - - + + + +
    Task Command & UtilitiesPurpose

    Task

    Command & Utilities

    Purpose

    1Prepare read setsrtg formatConvert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    1

    Prepare read sets

    rtg format

    Convert reference sequence from FASTA file to RTG Sequence Data Format (SDF)

    2Generate read set name maptext-editorProduce the map of names to read set SDF locations

    2

    Generate read set name map

    text-editor

    Produce the map of names to read set SDF locations

    3Run similarity toolrtg similarityProcess the read sets for similarity

    3

    Run similarity tool

    rtg similarity

    Process the read sets for similarity

    @@ -2456,9 +2357,110 @@

    Task 3 - Run similarity tool

    +
    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/rtg_command_reference.html b/installer/resources/core/RTGOperationsManual/rtg_command_reference.html index 6afb8b628..633b960ad 100644 --- a/installer/resources/core/RTGOperationsManual/rtg_command_reference.html +++ b/installer/resources/core/RTGOperationsManual/rtg_command_reference.html @@ -2,27 +2,27 @@ - + - - - RTG Command Reference — RTG Core Operations Manual v3.11 + + + RTG Command Reference — RTG Core Operations Manual v3.12 - - - - - - + + + + + + - +
    @@ -238,52 +89,52 @@

    RTG command syntax +--++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + +
    TypeDescription

    Type

    Description

    DIR, FILEFile or directory name(s)

    DIR, FILE

    File or directory name(s)

    SDFSequence data that has been formatted to SDF

    SDF

    Sequence data that has been formatted to SDF

    INTInteger value

    INT

    Integer value

    FLOATFloating point decimal value

    FLOAT

    Floating point decimal value

    STRINGA sequence of characters for comments, filenames, or labels

    STRING

    A sequence of characters for comments, filenames, or labels

    REGIONA genomic region specification (see below)

    REGION

    A genomic region specification (see below)

    Genomic region parameters take one of the following forms:

      -
    • sequence_name (e.g.: chr21) corresponds to the entirety of the -named sequence.
    • -
    • sequence_name:start (e.g.: chr21:100000) corresponds to a single -position on the named sequence.
    • -
    • sequence_name:start-end (e.g.: chr21:100000-110000) corresponds to a +
    • sequence_name (e.g.: chr21) corresponds to the entirety of the +named sequence.

    • +
    • sequence_name:start (e.g.: chr21:100000) corresponds to a single +position on the named sequence.

    • +
    • sequence_name:start-end (e.g.: chr21:100000-110000) corresponds to a range that extends from the specified start position to the specified -end position (inclusive). The positions are 1-based.

    • -
    • sequence_name:position+length (e.g.: chr21:100000+10000) corresponds +end position (inclusive). The positions are 1-based.

    • +
    • sequence_name:position+length (e.g.: chr21:100000+10000) corresponds to a range that extends from the specified start position that -includes the specified number of nucleotides.

    • -
    • sequence_name:position~padding (e.g.: chr21:100000~10000) +includes the specified number of nucleotides.

    • +
    • sequence_name:position~padding (e.g.: chr21:100000~10000) corresponds to a range that spans the specified position by the -specified amount of padding on either side.

    • +specified amount of padding on either side.

    To display all parameters and syntax associated with an RTG command, enter the command and type --help. For example: all parameters @@ -513,13 +364,13 @@

    RTG command syntax -

    Note

    -

    The following commands are synonymous: +

    Note

    +

    The following commands are synonymous: rtg help format and rtg format --help

    -

    See also

    -

    Refer to Installation and deployment for information +

    See also

    +

    Refer to Installation and deployment for information about installing the RTG product executable.

    @@ -557,111 +408,111 @@

    format +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -f--format=FORMATThe format of the input file(s). Allowed values are [fasta, fastq, fastq-interleaved, sam-se, sam-pe] (Default is fasta).

    -f

    --format=FORMAT

    The format of the input file(s). Allowed values are [fasta, fastq, fastq-interleaved, sam-se, sam-pe] (Default is fasta).

    -I--input-list-file=FILESpecifies a file containing a list of sequence data files (one per line) to be converted into an SDF.

    -I

    --input-list-file=FILE

    Specifies a file containing a list of sequence data files (one per line) to be converted into an SDF.

    -l--left=FILEThe left input file for FASTA/FASTQ paired end data.

    -l

    --left=FILE

    The left input file for FASTA/FASTQ paired end data.

    -o--output=SDFThe name of the output SDF.

    -o

    --output=SDF

    The name of the output SDF.

    -p--proteinSet if the input consists of protein. If this option is not specified, then the input is assumed to consist of nucleotides.

    -p

    --protein

    Set if the input consists of protein. If this option is not specified, then the input is assumed to consist of nucleotides.

    -q--quality-format=FORMATThe format of the quality data for fastq format files. (Use sanger for Illumina1.8+). Allowed values are [sanger, solexa, illumina].

    -q

    --quality-format=FORMAT

    The format of the quality data for fastq format files. (Use sanger for Illumina1.8+). Allowed values are [sanger, solexa, illumina].

    -r--right=FILEThe right input file for FASTA/FASTQ paired end data.

    -r

    --right=FILE

    The right input file for FASTA/FASTQ paired end data.

     FILE+Specifies a sequence data file to be converted into an SDF. May be specified 0 or more times.

    FILE+

    Specifies a sequence data file to be converted into an SDF. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --dusterTreat lower case residues as unknowns.

    --duster

    Treat lower case residues as unknowns.

     --exclude=STRINGExclude individual input sequences based on their name. If the input sequence name contains the specified string then that sequence is excluded from the -SDF. May be specified 0 or more times.

    --exclude=STRING

    Exclude individual input sequences based on their name. If the input sequence name contains the specified string then that sequence is excluded from the +SDF. May be specified 0 or more times.

     --select-read-group=STRINGSet to only include only reads with this read group ID when formatting from SAM/BAM files.

    --select-read-group=STRING

    Set to only include only reads with this read group ID when formatting from SAM/BAM files.

     --trim-threshold=INTSet to trim the read ends to maximise the base quality above the given threshold.

    --trim-threshold=INT

    Set to trim the read ends to maximise the base quality above the given threshold.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --allow-duplicate-namesSet to disable duplicate name detection.

    --allow-duplicate-names

    Set to disable duplicate name detection.

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

     --no-namesDo not include sequence names in the resulting SDF.

    --no-names

    Do not include sequence names in the resulting SDF.

     --no-qualityDo not include sequence quality data in the resulting SDF.

    --no-quality

    Do not include sequence quality data in the resulting SDF.

     --sam-rg=STRING|FILESpecifies a file containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:G1_SAMP\tPL:ILLUMINA.

    --sam-rg=STRING|FILE

    Specifies a file containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:G1_SAMP\tPL:ILLUMINA.

    @@ -731,17 +582,17 @@

    format -

    \arg \max x\left({\sum_{i=x+1}^l (T - q(i))}\right) \text{ if } q(l) < T

    +

    \arg \max x\left({\sum_{i=x+1}^l (T - q(i))}\right) \text{ if } q(l) < T

    Where l is the original read length, x is the new read length, T is the given threshold quality and q(n) is the quality of the base at the position n of the read.

    -

    Note

    +

    Note

    Sequencing system read files and reference genome files often have the same extension and it may not always be obvious which file is a read set and which is a genome. Before formatting a sequencing system file, open it to see which type of file it is. For example:

    -
    @@ -778,70 +629,70 @@

    cg2sdf +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILEFile containing a list of Complete Genomics TSV files (1 per line)

    -I

    --input-list-file=FILE

    File containing a list of Complete Genomics TSV files (1 per line)

    -o--output=SDFName of output SDF.

    -o

    --output=SDF

    Name of output SDF.

     FILE+File in Complete Genomics TSV format. May be specified 0 or more times.

    FILE+

    File in Complete Genomics TSV format. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Filtering

    Filtering

     --max-unknowns=INTMaximum number of Ns allowed in either side for a read (Default is 5)

    --max-unknowns=INT

    Maximum number of Ns allowed in either side for a read (Default is 5)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-qualityDoes not include quality data in the resulting SDF.

    --no-quality

    Does not include quality data in the resulting SDF.

     --sam-rg=STRING|FILEFile containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:G1_SAMP\tPL:COMPLETE.

    --sam-rg=STRING|FILE

    File containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:G1_SAMP\tPL:COMPLETE.

    @@ -871,8 +722,8 @@

    cg2sdf -

    See also

    -

    format, +

    See also

    +

    format, sdf2cg, cgmap, sdf2fasta, @@ -899,82 +750,82 @@

    sdf2cg +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=SDFSDF containing sequences

    -i

    --input=SDF

    SDF containing sequences

    -o--output=FILEOutput filename (extension added if not present). Use ‘-‘ to write to standard output

    -o

    --output=FILE

    Output filename (extension added if not present). Use ‘-‘ to write to standard output

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --end-id=INTExclusive upper bound on sequence id

    --end-id=INT

    Exclusive upper bound on sequence id

    -I--id-file=FILEFile containing sequence ids, or sequence names if –names flag is set, one per line

    -I

    --id-file=FILE

    File containing sequence ids, or sequence names if –names flag is set, one per line

    -n--namesInterpret supplied sequence as names instead of numeric ids

    -n

    --names

    Interpret supplied sequence as names instead of numeric ids

     --start-id=INTInclusive lower bound on sequence id

    --start-id=INT

    Inclusive lower bound on sequence id

     STRING+ID of sequence to extract, or sequence name if –names flag is set. May be specified 0 or more times

    STRING+

    ID of sequence to extract, or sequence name if –names flag is set. May be specified 0 or more times

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage

    -h

    --help

    Print help on command-line flag usage

    -l--line-length=INTMaximum number of nucleotides to print on a line of output. A value of 0 indicates no limit (Default is 0)

    -l

    --line-length=INT

    Maximum number of nucleotides to print on a line of output. A value of 0 indicates no limit (Default is 0)

    -Z--no-gzipDo not gzip the output

    -Z

    --no-gzip

    Do not gzip the output

    @@ -988,8 +839,8 @@

    sdf2cg -

    See also

    -

    cg2sdf

    +

    See also

    +

    cg2sdf

    @@ -1005,91 +856,91 @@

    sdf2fasta +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=SDFSDF containing sequences.

    -i

    --input=SDF

    SDF containing sequences.

    -o--output=FILEOutput filename (extension added if not present). Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output filename (extension added if not present). Use ‘-‘ to write to standard output.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --end-id=INTOnly output sequences with sequence id less than the given number. (Sequence ids start at 0).

    --end-id=INT

    Only output sequences with sequence id less than the given number. (Sequence ids start at 0).

     --start-id=INTOnly output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    --start-id=INT

    Only output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    -I--id-file=FILEName of a file containing a list of sequences to extract, one per line.

    -I

    --id-file=FILE

    Name of a file containing a list of sequences to extract, one per line.

     --namesInterpret any specified sequence as names instead of numeric sequence ids.

    --names

    Interpret any specified sequence as names instead of numeric sequence ids.

     --taxonsInterpret any specified sequence as taxon ids instead of numeric sequence ids. This option only applies to a metagenomic reference species SDF.

    --taxons

    Interpret any specified sequence as taxon ids instead of numeric sequence ids. This option only applies to a metagenomic reference species SDF.

     STRING+Specify one or more explicit sequences to extract, as sequence id, or sequence name if –names flag is set.

    STRING+

    Specify one or more explicit sequences to extract, as sequence id, or sequence name if –names flag is set.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

     --interleaveInterleave paired data into a single output file. Default is to split to separate output files.

    --interleave

    Interleave paired data into a single output file. Default is to split to separate output files.

    -l--line-length=INTSet the maximum number of nucleotides or amino acids to print on a line of FASTA output. Should be nonnegative, with a value of 0 indicating that the line -length is not capped. (Default is 0).

    -l

    --line-length=INT

    Set the maximum number of nucleotides or amino acids to print on a line of FASTA output. Should be nonnegative, with a value of 0 indicating that the line +length is not capped. (Default is 0).

    -Z--no-gzipSet this flag to create the FASTA output file without compression. By default the output file is compressed with blocked gzip.

    -Z

    --no-gzip

    Set this flag to create the FASTA output file without compression. By default the output file is compressed with blocked gzip.

    @@ -1124,8 +975,8 @@

    sdf2fasta -

    See also

    -

    format, +

    See also

    +

    format, sdf2fastq, sdfstats

    @@ -1143,91 +994,91 @@

    sdf2fastq +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=SDFSpecifies the SDF data to be converted.

    -i

    --input=SDF

    Specifies the SDF data to be converted.

    -o--output=FILESpecifies the file name used to write the resulting FASTQ output.

    -o

    --output=FILE

    Specifies the file name used to write the resulting FASTQ output.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --end-id=INTOnly output sequences with sequence id less than the given number. (Sequence ids start at 0).

    --end-id=INT

    Only output sequences with sequence id less than the given number. (Sequence ids start at 0).

     --start-id=INTOnly output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    --start-id=INT

    Only output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    -I--id-file=FILEName of a file containing a list of sequences to extract, one per line.

    -I

    --id-file=FILE

    Name of a file containing a list of sequences to extract, one per line.

     --namesInterpret any specified sequence as names instead of numeric sequence ids.

    --names

    Interpret any specified sequence as names instead of numeric sequence ids.

     STRING+Specify one or more explicit sequences to extract, as sequence id, or sequence name if –names flag is set.

    STRING+

    Specify one or more explicit sequences to extract, as sequence id, or sequence name if –names flag is set.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -q--default-qualty=INTSet the default quality to use if the SDF does not contain sequence quality data (0-63).

    -q

    --default-qualty=INT

    Set the default quality to use if the SDF does not contain sequence quality data (0-63).

     --interleaveInterleave paired data into a single output file. Default is to split to separate output files.

    --interleave

    Interleave paired data into a single output file. Default is to split to separate output files.

    -l--line-length=INTSet the maximum number of nucleotides or amino acids to print on a line of FASTQ output. Should be nonnegative, with a value of 0 indicating that the line -length is not capped. (Default is 0).

    -l

    --line-length=INT

    Set the maximum number of nucleotides or amino acids to print on a line of FASTQ output. Should be nonnegative, with a value of 0 indicating that the line +length is not capped. (Default is 0).

    -Z--no-gzipSet this flag to create the FASTQ output file without compression. By default the output file is compressed with blocked gzip.

    -Z

    --no-gzip

    Set this flag to create the FASTQ output file without compression. By default the output file is compressed with blocked gzip.

    @@ -1247,8 +1098,8 @@

    sdf2fastq--start-id and --end-id flags behave as in sdf2fasta.

    -

    See also

    -

    format, +

    See also

    +

    format, sdf2fasta, sdf2sam, sdfstats

    @@ -1267,79 +1118,79 @@

    sdf2sam +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=SDFSpecifies the SDF data to be converted.

    -i

    --input=SDF

    Specifies the SDF data to be converted.

    -o--output=FILESpecifies the file name used to write the resulting SAM/BAM to. The output format is automatically determined based on the -filename specified. If ‘-‘ is given, the data is written as uncompressed SAM to standard output.

    -o

    --output=FILE

    Specifies the file name used to write the resulting SAM/BAM to. The output format is automatically determined based on the +filename specified. If ‘-‘ is given, the data is written as uncompressed SAM to standard output.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --end-id=INTOnly output sequences with sequence id less than the given number. (Sequence ids start at 0).

    --end-id=INT

    Only output sequences with sequence id less than the given number. (Sequence ids start at 0).

     --start-id=INTOnly output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    --start-id=INT

    Only output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    -I--id-file=FILEName of a file containing a list of sequences to extract, one per line.

    -I

    --id-file=FILE

    Name of a file containing a list of sequences to extract, one per line.

     --namesInterpret any specified sequence as names instead of numeric sequence ids.

    --names

    Interpret any specified sequence as names instead of numeric sequence ids.

     STRING+Specify one or more explicit sequences to extract, as sequence id, or sequence name if –names flag is set.

    STRING+

    Specify one or more explicit sequences to extract, as sequence id, or sequence name if –names flag is set.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -Z--no-gzipSet this flag when creating SAM format output to disable compression. By default SAM is compressed with blocked gzip, and BAM is always compressed.

    -Z

    --no-gzip

    Set this flag when creating SAM format output to disable compression. By default SAM is compressed with blocked gzip, and BAM is always compressed.

    @@ -1360,8 +1211,8 @@

    sdf2sam--start-id and --end-if behave as in sdf2fasta.

    -

    See also

    -

    format, +

    See also

    +

    format, sdf2fasta, sdf2fastq, sdfstats, @@ -1383,102 +1234,102 @@

    fastqtrim +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILEInput FASTQ file, Use ‘-‘ to read from standard input.

    -i

    --input=FILE

    Input FASTQ file, Use ‘-‘ to read from standard input.

    -o--output=FILEOutput filename. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output filename. Use ‘-‘ to write to standard output.

    -q--quality-format=FORMATQuality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -q

    --quality-format=FORMAT

    Quality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --discard-empty-readsDiscard reads that have zero length after trimming. Should not be used with paired-end data.

    --discard-empty-reads

    Discard reads that have zero length after trimming. Should not be used with paired-end data.

    -E--end-quality-threshold=INTTrim read ends to maximise base quality above the given threshold (Default is 0)

    -E

    --end-quality-threshold=INT

    Trim read ends to maximise base quality above the given threshold (Default is 0)

     --min-read-length=INTIf a read ends up shorter than this threshold it will be trimmed to zero length (Default is 0)

    --min-read-length=INT

    If a read ends up shorter than this threshold it will be trimmed to zero length (Default is 0)

    -S--start-quality-threshold=INTTrim read starts to maximise base quality above the given threshold (Default is 0)

    -S

    --start-quality-threshold=INT

    Trim read starts to maximise base quality above the given threshold (Default is 0)

    -e--trim-end-bases=INTAlways trim the specified number of bases from read end (Default is 0)

    -e

    --trim-end-bases=INT

    Always trim the specified number of bases from read end (Default is 0)

    -s--trim-start-bases=INTAlways trim the specified number of bases from read start (Default is 0)

    -s

    --trim-start-bases=INT

    Always trim the specified number of bases from read start (Default is 0)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -r--reverse-complementIf set, output in reverse complement.

    -r

    --reverse-complement

    If set, output in reverse complement.

     --seed=INTSeed used during subsampling.

    --seed=INT

    Seed used during subsampling.

     --subsample=FLOATIf set, subsample the input to retain this fraction of reads.

    --subsample=FLOAT

    If set, subsample the input to retain this fraction of reads.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -1497,7 +1348,7 @@

    fastqtrim -

    \arg \max x\left({\sum_{i=x+1}^l (T - q(i))}\right) \text{ if } q(l) < T

    +

    \arg \max x\left({\sum_{i=x+1}^l (T - q(i))}\right) \text{ if } q(l) < T

    where l is the original read length, x is the new read length, T is the given threshold quality and q(n) is the quality of the base at the position n of the read. Similarly, --start-quality-threshold @@ -1528,8 +1379,8 @@

    Formatting with filtering on the fly -

    See also

    -

    format

    +

    See also

    +

    format

    @@ -1542,159 +1393,159 @@

    petrim +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -l--left=FILELeft input FASTQ file (AKA R1)

    -l

    --left=FILE

    Left input FASTQ file (AKA R1)

    -o--output=FILEOutput filename prefix. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output filename prefix. Use ‘-‘ to write to standard output.

    -q--quality-format=FORMATQuality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -q

    --quality-format=FORMAT

    Quality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -r--right=FILERight input FASTQ file (AKA R2)

    -r

    --right=FILE

    Right input FASTQ file (AKA R2)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --aligner-band-width=FLOATAligner indel band width scaling factor, fraction of read length allowed as an indel (Default is 0.5)

    --aligner-band-width=FLOAT

    Aligner indel band width scaling factor, fraction of read length allowed as an indel (Default is 0.5)

     --gap-extend-penalty=INTPenalty for a gap extension during alignment (Default is 1)

    --gap-extend-penalty=INT

    Penalty for a gap extension during alignment (Default is 1)

     --gap-open-penalty=INTPenalty for a gap open during alignment (Default is 19)

    --gap-open-penalty=INT

    Penalty for a gap open during alignment (Default is 19)

    -P--min-identity=INTMinimum percent identity in overlap to trigger overlap trimming (Default is 90)

    -P

    --min-identity=INT

    Minimum percent identity in overlap to trigger overlap trimming (Default is 90)

    -L--min-overlap-length=INTMinimum number of bases in overlap to trigger overlap trimming (Default is 25)

    -L

    --min-overlap-length=INT

    Minimum number of bases in overlap to trigger overlap trimming (Default is 25)

     --mismatch-penalty=INTPenalty for a mismatch during alignment (Default is 9)

    --mismatch-penalty=INT

    Penalty for a mismatch during alignment (Default is 9)

     --soft-clip-distance=INTSoft clip alignments if indels occur INT bp from either end (Default is 5)

    --soft-clip-distance=INT

    Soft clip alignments if indels occur INT bp from either end (Default is 5)

     --unknowns-penalty=INTPenalty for unknown nucleotides during alignment (Default is 5)

    --unknowns-penalty=INT

    Penalty for unknown nucleotides during alignment (Default is 5)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --discard-empty-pairsIf set, discard pairs where both reads have zero length (after any trimming)

    --discard-empty-pairs

    If set, discard pairs where both reads have zero length (after any trimming)

     --discard-empty-readsIf set, discard pairs where either read has zero length (after any trimming)

    --discard-empty-reads

    If set, discard pairs where either read has zero length (after any trimming)

     --left-probe-length=INTAssume R1 starts with probes this long, and trim R2 bases that overlap into this (Default is 0)

    --left-probe-length=INT

    Assume R1 starts with probes this long, and trim R2 bases that overlap into this (Default is 0)

    -M--midpoint-mergeIf set, merge overlapping reads at midpoint of overlap region. Result is in R1 (R2 will be empty)

    -M

    --midpoint-merge

    If set, merge overlapping reads at midpoint of overlap region. Result is in R1 (R2 will be empty)

    -m--midpoint-trimIf set, trim overlapping reads to midpoint of overlap region.

    -m

    --midpoint-trim

    If set, trim overlapping reads to midpoint of overlap region.

     --min-read-length=INTIf a read ends up shorter than this threshold it will be trimmed to zero length (Default is 0)

    --min-read-length=INT

    If a read ends up shorter than this threshold it will be trimmed to zero length (Default is 0)

     --mismatch-adjustment=STRINGMethod used to alter bases/qualities at mismatches within overlap region. Allowed values are [none, zero-phred, pick-best] (Default is none)

    --mismatch-adjustment=STRING

    Method used to alter bases/qualities at mismatches within overlap region. Allowed values are [none, zero-phred, pick-best] (Default is none)

     --right-probe-length=INTAssume R2 starts with probes this long, and trim R1 bases that overlap into this (Default is 0)

    --right-probe-length=INT

    Assume R2 starts with probes this long, and trim R1 bases that overlap into this (Default is 0)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --interleaveInterleave paired data into a single output file. Default is to split to separate output files.

    --interleave

    Interleave paired data into a single output file. Default is to split to separate output files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --seed=INTSeed used during subsampling.

    --seed=INT

    Seed used during subsampling.

     --subsample=FLOATIf set, subsample the input to retain this fraction of reads.

    --subsample=FLOAT

    If set, subsample the input to retain this fraction of reads.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -1722,29 +1573,29 @@

    petrim -
  • Removal of non-genomic bases due to complete read-through. This -removal is always applied.
  • -
  • Removal of overlap bases impinging into regions occupied by probe +
  • Removal of non-genomic bases due to complete read-through. This +removal is always applied.

  • +
  • Removal of overlap bases impinging into regions occupied by probe bases. For example, if the left arms contain 11-mer probes, using --left-probe-length=11 will result in the removal of any right arm bases that overlap into the first 11 bases of the left arm. Similar trimming is available for situations where probes are ligated to the -right arm by using --right-probe-length.

  • -
  • Adjustment of mismatching read bases inside areas of overlap. Such +right arm by using --right-probe-length.

  • +
  • Adjustment of mismatching read bases inside areas of overlap. Such mismatches indicate that one or other of the bases has been incorrectly sequenced. Alteration of these bases is selected by supplying the --mismatch-adjustment flag with a value of zero-phred to alter the phred quality score of both bases to zero, or pick-best to choose whichever base had the higher reported -quality score.

  • -
  • Removal of overlap regions by trimming both arms back to a point where +quality score.

  • +
  • Removal of overlap regions by trimming both arms back to a point where no overlap is present. An equal number of bases are removed from each arm. This trimming is enabled by specifying --midpoint-trim and -takes place after any read-through or probe related trimming.

  • -
  • Merging non-redundant sequence from both reads to create a single +takes place after any read-through or probe related trimming.

  • +
  • Merging non-redundant sequence from both reads to create a single read, enabled via --midpoint-merge. This is like --midpoint-trim with a subsequent moving of the R2 read onto the -end of the the R1 read (thus the R2 read becomes empty).

  • +end of the the R1 read (thus the R2 read becomes empty).

    After trimming or merging it is possible that one or both of the arms of the pair have no bases remaining, and a strategy is needed to handle @@ -1777,8 +1628,8 @@

    Formatting with paired-end trimming on the fly -

    Note

    -

    petrim currently assumes Illumina paired-end sequencing, +

    Note

    +

    petrim currently assumes Illumina paired-end sequencing, and aligns the reads in FR orientation. Sequencing methods which produce arms in a different orientation can be processed by first converting the input files using fastqtrim --reverse-complement, @@ -1787,8 +1638,8 @@

    Formatting with paired-end trimming on the fly -

    See also

    -

    fastqtrim, +

    See also

    +

    fastqtrim, format

    @@ -1817,269 +1668,269 @@

    map

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -F--format=FORMATInput format for reads. Allowed values are [sdf, fasta, fastq, fastq-interleaved, sam-se, sam-pe] (Default is sdf)

    -F

    --format=FORMAT

    Input format for reads. Allowed values are [sdf, fasta, fastq, fastq-interleaved, sam-se, sam-pe] (Default is sdf)

    -i--input=SDF|FILEInput read set.

    -i

    --input=SDF|FILE

    Input read set.

    -l--left=FILELeft input file for FASTA/FASTQ paired end reads.

    -l

    --left=FILE

    Left input file for FASTA/FASTQ paired end reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -q--quality-format=FORMATQuality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -q

    --quality-format=FORMAT

    Quality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -r--right=FILERight input file for FASTA/FASTQ paired end reads.

    -r

    --right=FILE

    Right input file for FASTA/FASTQ paired end reads.

     --samOutput the alignment files in SAM format.

    --sam

    Output the alignment files in SAM format.

    -t--template=SDFSDF containing template to map against.

    -t

    --template=SDF

    SDF containing template to map against.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +omitting the percent symbol) where any hash exceeding the threshold will be discarded from the index. (Default is 90%).

    - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --aligner-band-width=FLOATSet the fraction of the read length that is allowed to be an indel. Decreasing this factor will allow faster processing, at the expense of only -allowing shorter indels to be aligned. (Default is 0.5).

    --aligner-band-width=FLOAT

    Set the fraction of the read length that is allowed to be an indel. Decreasing this factor will allow faster processing, at the expense of only +allowing shorter indels to be aligned. (Default is 0.5).

     --aligner-mode=STRINGSet the aligner mode to be used. Allowed values are [auto, table, general] (Default is auto).

    --aligner-mode=STRING

    Set the aligner mode to be used. Allowed values are [auto, table, general] (Default is auto).

     --bed-regions=FILERestrict calibration to mappings falling within the regions in the supplied BED file.

    --bed-regions=FILE

    Restrict calibration to mappings falling within the regions in the supplied BED file.

     --blacklist-threshold=INTfilter k-mers that occur more than this many times in the reference using a blacklist

    --blacklist-threshold=INT

    filter k-mers that occur more than this many times in the reference using a blacklist

     --gap-extend-penalty=INTSet the penalty for extending a gap during alignment. (Default is 1).

    --gap-extend-penalty=INT

    Set the penalty for extending a gap during alignment. (Default is 1).

     --gap-open-penalty=INTSet the penalty for a gap open during alignment. (Default is 19).

    --gap-open-penalty=INT

    Set the penalty for a gap open during alignment. (Default is 19).

    -c--indel-length=INTGuarantees number of positions that will be detected in a single indel. For example, -c 3 specifies 3 nucleotide insertions or deletions. (Default is -1).

    -c

    --indel-length=INT

    Guarantees number of positions that will be detected in a single indel. For example, -c 3 specifies 3 nucleotide insertions or deletions. (Default is +1).

    -b--indels=INTGuarantees minimum number of indels which will be detected when used with read less than 64 bp long. For example -b 1 specifies 1 insertion or -deletion. (Default is 1).

    -b

    --indels=INT

    Guarantees minimum number of indels which will be detected when used with read less than 64 bp long. For example -b 1 specifies 1 insertion or +deletion. (Default is 1).

    -M--max-fragment-size=INTThe maximum permitted fragment size when mating paired reads. (Default is 1000).

    -M

    --max-fragment-size=INT

    The maximum permitted fragment size when mating paired reads. (Default is 1000).

    -m--min-fragment-size=INTThe minimum permitted fragment size when mating paired reads. (Default is 0).

    -m

    --min-fragment-size=INT

    The minimum permitted fragment size when mating paired reads. (Default is 0).

     --mismatch-penalty=INTSet the penalty for a mismatch during alignment. (Default is 9).

    --mismatch-penalty=INT

    Set the penalty for a mismatch during alignment. (Default is 9).

    -d--orientation=STRINGSet the orientation required for proper pairs. Allowed values are [fr, rf, tandem, any] (Default is any).

    -d

    --orientation=STRING

    Set the orientation required for proper pairs. Allowed values are [fr, rf, tandem, any] (Default is any).

     --pedigree=FILEGenome relationships pedigree containing sex of sample.

    --pedigree=FILE

    Genome relationships pedigree containing sex of sample.

     --repeat-freq=INT%Where INT specifies the percentage of all hashes to keep, discarding the remaining percentage of the most frequent hashes. Increasing this value will +

    --repeat-freq=INT%

    Where INT specifies the percentage of all hashes to keep, discarding the remaining percentage of the most frequent hashes. Increasing this value will improve the ability to map sequences in repetitive regions at a cost of run time. It is also possible to specify the option as an absolute count (by -omitting the percent symbol) where any hash exceeding the threshold will be discarded from the index. (Default is 90%).

     --sex=SEXSpecifies the sex of the individual. Allowed values are [male, female, either].

    --sex=SEX

    Specifies the sex of the individual. Allowed values are [male, female, either].

     --soft-clip-distance=INTSet to soft clip alignments when an indel occurs within that many nucleotides from either end of the read. (Default is 5).

    --soft-clip-distance=INT

    Set to soft clip alignments when an indel occurs within that many nucleotides from either end of the read. (Default is 5).

    -s--step=INTSet the step size. (Default is word size).

    -s

    --step=INT

    Set the step size. (Default is word size).

    -a--substitutions=INTGuarantees minimum number of substitutions to be detected when used with read data less than 64 bp long. (Default is 1).

    -a

    --substitutions=INT

    Guarantees minimum number of substitutions to be detected when used with read data less than 64 bp long. (Default is 1).

     --unknowns-penalty=INTSet the penalty for unknown nucleotides during alignment. (Default is 5).

    --unknowns-penalty=INT

    Set the penalty for unknown nucleotides during alignment. (Default is 5).

    -w--word=INTSpecifies an internal minimum word size used during the initial matching phase. Word size selection optimizes the number of reads for a desired level -of sensitivity (allowed mismatches and indels) given an acceptable alignment speed. (Default is 22, or read length / 2, whichever is smaller).

    -w

    --word=INT

    Specifies an internal minimum word size used during the initial matching phase. Word size selection optimizes the number of reads for a desired level +of sensitivity (allowed mismatches and indels) given an acceptable alignment speed. (Default is 22, or read length / 2, whichever is smaller).

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Filtering

    Filtering

     --end-read=INTOnly map sequences with sequence id less than the given number. (Sequence ids start at 0).

    --end-read=INT

    Only map sequences with sequence id less than the given number. (Sequence ids start at 0).

     --start-read=INTOnly map sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    --start-read=INT

    Only map sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --all-hitsOutput all alignments meeting thresholds instead of applying mating and N limits.

    --all-hits

    Output all alignments meeting thresholds instead of applying mating and N limits.

     --max-mated-mismatches=INTThe maximum mismatches for mappings across mated results, alias for --max-mismatches (as absolute value or percentage of read length). (Default -is 10%).

    --max-mated-mismatches=INT

    The maximum mismatches for mappings across mated results, alias for --max-mismatches (as absolute value or percentage of read length). (Default +is 10%).

    -e--max-mismatches=INTThe maximum mismatches for mappings in single-end mode (as absolute value or percentage of read length). (Default is 10%).

    -e

    --max-mismatches=INT

    The maximum mismatches for mappings in single-end mode (as absolute value or percentage of read length). (Default is 10%).

    -n--max-top-results=INTSets the maximum number of reported mapping results (locations) per read when it maps to multiple locations with the same alignment score -(AS). Allowed values are between 1 and 255. (Default is 5).

    -n

    --max-top-results=INT

    Sets the maximum number of reported mapping results (locations) per read when it maps to multiple locations with the same alignment score +(AS). Allowed values are between 1 and 255. (Default is 5).

    -E--max-unmated-mismatches=INTThe maximum mismatches for mappings of unmated results (as absolute value or percentage of read length). (Default is 10%).

    -E

    --max-unmated-mismatches=INT

    The maximum mismatches for mappings of unmated results (as absolute value or percentage of read length). (Default is 10%).

     --sam-rg=STRING|FILESpecifies a file containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:BACT\tPL:ILLUMINA.

    --sam-rg=STRING|FILE

    Specifies a file containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:BACT\tPL:ILLUMINA.

     --top-randomIf set, will only output a single random top hit for each read.

    --top-random

    If set, will only output a single random top hit for each read.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

     --legacy-cigarsProduce cigars in legacy format (using M instead of X or =) in SAM/BAM output. When set will also produce the MD field.

    --legacy-cigars

    Produce cigars in legacy format (using M instead of X or =) in SAM/BAM output. When set will also produce the MD field.

     --no-calibrationSet this flag to not produce the calibration output files.

    --no-calibration

    Set this flag to not produce the calibration output files.

    -Z--no-gzipSet this flag to create the SAM output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

    -Z

    --no-gzip

    Set this flag to create the SAM output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

     --no-mergeSet to output mated, unmated and unmapped alignment records into separate SAM/BAM files.

    --no-merge

    Set to output mated, unmated and unmapped alignment records into separate SAM/BAM files.

     --no-svprepDo not perform structural variant processing.

    --no-svprep

    Do not perform structural variant processing.

     --no-unmappedDo not output unmapped reads. Some reads that map multiple times will not be aligned, and are reported as unmapped. These reads are reported with XC attributes that -indicate the reason they were not mapped.

    --no-unmapped

    Do not output unmapped reads. Some reads that map multiple times will not be aligned, and are reported as unmapped. These reads are reported with XC attributes that +indicate the reason they were not mapped.

     --no-unmatedDo not output unmated reads when in paired-end mode.

    --no-unmated

    Do not output unmated reads when in paired-end mode.

     --read-namesOutput read names instead of sequence ids in SAM/BAM files. (Uses more RAM).

    --read-names

    Output read names instead of sequence ids in SAM/BAM files. (Uses more RAM).

     --tempdir=DIRSet the directory to use for temporary files during processing. (Defaults to output directory).

    --tempdir=DIR

    Set the directory to use for temporary files during processing. (Defaults to output directory).

    -T--threads=INTSpecify the number of threads to use in a multi-core processor. (Default is all available cores).

    -T

    --threads=INT

    Specify the number of threads to use in a multi-core processor. (Default is all available cores).

    @@ -2250,8 +2101,8 @@

    mapTask 4 - Map reads to the reference genome.

    -

    See also

    -

    format, +

    See also

    +

    format, calibrate, cgmap, mapf, @@ -2280,240 +2131,240 @@

    mapf

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bamOutput the alignment files in BAM format.

    --bam

    Output the alignment files in BAM format.

    -F--format=FORMATInput format for reads. Allowed values are [sdf, fasta, fastq, fastq-interleaved, sam-se, sam-pe] (Default is sdf)

    -F

    --format=FORMAT

    Input format for reads. Allowed values are [sdf, fasta, fastq, fastq-interleaved, sam-se, sam-pe] (Default is sdf)

    -i--input=SDF|FILEInput read set.

    -i

    --input=SDF|FILE

    Input read set.

    -l--left=FILELeft input file for FASTA/FASTQ paired end reads.

    -l

    --left=FILE

    Left input file for FASTA/FASTQ paired end reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -q--quality-format=FORMATQuality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -q

    --quality-format=FORMAT

    Quality data encoding method used in FASTQ input files (Illumina 1.8+ uses sanger). Allowed values are [sanger, solexa, illumina] (Default is sanger)

    -r--right=FILERight input file for FASTA/FASTQ paired end reads.

    -r

    --right=FILE

    Right input file for FASTA/FASTQ paired end reads.

     --samOutput the alignment files in SAM format.

    --sam

    Output the alignment files in SAM format.

    -t--template=SDFSDF containing template to map against.

    -t

    --template=SDF

    SDF containing template to map against.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +threshold will be discarded from the index. (Default is 90%).

    - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +is 22).

    Sensitivity Tuning

    Sensitivity Tuning

     --aligner-band-width=FLOATSet the fraction of the read length that is allowed to be an indel. Decreasing this factor will allow faster processing, -at the expense of only allowing shorter indels to be aligned. (Default is 0.5).

    --aligner-band-width=FLOAT

    Set the fraction of the read length that is allowed to be an indel. Decreasing this factor will allow faster processing, +at the expense of only allowing shorter indels to be aligned. (Default is 0.5).

     --aligner-mode=STRINGSet the aligner mode to be used. Allowed values are [auto, table, general] (Default is auto).

    --aligner-mode=STRING

    Set the aligner mode to be used. Allowed values are [auto, table, general] (Default is auto).

     --blacklist-threshold=INTfilter k-mers that occur more than this many times in the reference using a blacklist

    --blacklist-threshold=INT

    filter k-mers that occur more than this many times in the reference using a blacklist

     --gap-extend-penalty=INTSet the penalty for extending a gap during alignment. (Default is 1).

    --gap-extend-penalty=INT

    Set the penalty for extending a gap during alignment. (Default is 1).

     --gap-open-penalty=INTSet the penalty for a gap open during alignment. (Default is 19).

    --gap-open-penalty=INT

    Set the penalty for a gap open during alignment. (Default is 19).

    -c--indel-length=INTGuarantees number of positions that will be detected in a single indel. For example, -c 3 specifies 3 nucleotide -insertions or deletions. (Default is 1).

    -c

    --indel-length=INT

    Guarantees number of positions that will be detected in a single indel. For example, -c 3 specifies 3 nucleotide +insertions or deletions. (Default is 1).

    -b--indels=INTGuarantees minimum number of indels which will be detected when used with read less than 64 bp long. For example -b 1 -specifies 1 insertion or deletion. (Default is 1).

    -b

    --indels=INT

    Guarantees minimum number of indels which will be detected when used with read less than 64 bp long. For example -b 1 +specifies 1 insertion or deletion. (Default is 1).

    -M--max-fragment-size=INTThe maximum permitted fragment size when mating paired reads. (Default is 1000).

    -M

    --max-fragment-size=INT

    The maximum permitted fragment size when mating paired reads. (Default is 1000).

    -m--min-fragment-size=INTThe minimum permitted fragment size when mating paired reads. (Default is 0).

    -m

    --min-fragment-size=INT

    The minimum permitted fragment size when mating paired reads. (Default is 0).

     --mismatch-penalty=INTSet the penalty for a mismatch during alignment. (Default is 9).

    --mismatch-penalty=INT

    Set the penalty for a mismatch during alignment. (Default is 9).

    -d--orientation=STRINGSet the orientation required for proper pairs. Allowed values are [fr, rf, tandem, any] (Default is any).

    -d

    --orientation=STRING

    Set the orientation required for proper pairs. Allowed values are [fr, rf, tandem, any] (Default is any).

     --pedigree=FILEGenome relationships pedigree containing sex of sample.

    --pedigree=FILE

    Genome relationships pedigree containing sex of sample.

     --repeat-freq=INT%Where INT specifies the percentage of all hashes to keep, discarding the remaining percentage of the most frequent +

    --repeat-freq=INT%

    Where INT specifies the percentage of all hashes to keep, discarding the remaining percentage of the most frequent hashes. Increasing this value will improve the ability to map sequences in repetitive regions at a cost of run time. It is also possible to specify the option as an absolute count (by omitting the percent symbol) where any hash exceeding the -threshold will be discarded from the index. (Default is 90%).

     --sex=SEXSpecifies the sex of the individual. Allowed values are [male, female, either].

    --sex=SEX

    Specifies the sex of the individual. Allowed values are [male, female, either].

     --soft-clip-distance=INTSet to soft clip alignments when an indel occurs within that many nucleotides from either end of the read. (Default is 5).

    --soft-clip-distance=INT

    Set to soft clip alignments when an indel occurs within that many nucleotides from either end of the read. (Default is 5).

    -s--step=INTSet the step size. (Default is half word size).

    -s

    --step=INT

    Set the step size. (Default is half word size).

    -a--substitutions=INTGuarantees minimum number of substitutions to be detected when used with read data less than 64 bp long. (Default is 1).

    -a

    --substitutions=INT

    Guarantees minimum number of substitutions to be detected when used with read data less than 64 bp long. (Default is 1).

     --unknowns-penalty=INTSet the penalty for unknown nucleotides during alignment. (Default is 5).

    --unknowns-penalty=INT

    Set the penalty for unknown nucleotides during alignment. (Default is 5).

    -w--word=INTSpecifies an internal minimum word size used during the initial matching phase. Word size selection optimizes the number +

    -w

    --word=INT

    Specifies an internal minimum word size used during the initial matching phase. Word size selection optimizes the number of reads for a desired level of sensitivity (allowed mismatches and indels) given an acceptable alignment speed. (Default -is 22).

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Filtering

    Filtering

     --end-read=INTExclusive upper bound on read id.

    --end-read=INT

    Exclusive upper bound on read id.

     --start-read=INTInclusive lower bound on read id.

    --start-read=INT

    Inclusive lower bound on read id.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --max-mated-mismatches=INTMaximum mismatches for mappings across mated results, alias for –max-mismatches (as absolute value or percentage of read length) (Default is 10%)

    --max-mated-mismatches=INT

    Maximum mismatches for mappings across mated results, alias for –max-mismatches (as absolute value or percentage of read length) (Default is 10%)

    -e--max-mismatches=INTMaximum mismatches for mappings in single-end mode (as absolute value or percentage of read length) (Default is 10%)

    -e

    --max-mismatches=INT

    Maximum mismatches for mappings in single-end mode (as absolute value or percentage of read length) (Default is 10%)

    -E--max-unmated-mismatches=INTMaximum mismatches for mappings of unmated results (as absolute value or percentage of read length) (Default is 10%)

    -E

    --max-unmated-mismatches=INT

    Maximum mismatches for mappings of unmated results (as absolute value or percentage of read length) (Default is 10%)

     --sam-rg=STRING|FILEFile containing a single valid read group SAM header line or a string in the form @RG\tID:READGROUP1\tSM:BACT_SAMPLE\tPL:ILLUMINA

    --sam-rg=STRING|FILE

    File containing a single valid read group SAM header line or a string in the form @RG\tID:READGROUP1\tSM:BACT_SAMPLE\tPL:ILLUMINA

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --legacy-cigarsUse legacy cigars in output.

    --legacy-cigars

    Use legacy cigars in output.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-mergeOutput mated/unmated/unmapped alignments into separate SAM/BAM files.

    --no-merge

    Output mated/unmated/unmapped alignments into separate SAM/BAM files.

     --read-namesUse read name in output instead of read id (Uses more RAM)

    --read-names

    Use read name in output instead of read id (Uses more RAM)

     --tempdir=DIRDirectory used for temporary files (Defaults to output directory)

    --tempdir=DIR

    Directory used for temporary files (Defaults to output directory)

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -2531,15 +2382,15 @@

    mapf¶ and the other did not. Thus, with mapf, if either end of the read maps to the contaminant database, both arms of the read are filtered.

    -

    Note

    -

    The --sam-rg flag specifies the read group information +

    Note

    +

    The --sam-rg flag specifies the read group information when outputting to SAM/BAM and also adjusts the internal aligner configuration based on the platform given. Recognized platforms are ILLUMINA, LS454, and IONTORRENT.

    -

    See also

    -

    map, +

    See also

    +

    map, cgmap, mapx

    @@ -2557,196 +2408,196 @@

    cgmap

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -F--format=FORMATFormat of read data. Allowed values are [sdf, tsv] (Default is sdf)

    -F

    --format=FORMAT

    Format of read data. Allowed values are [sdf, tsv] (Default is sdf)

    -i--input=SDF|FILESpecifies the Complete Genomics reads to be mapped.

    -i

    --input=SDF|FILE

    Specifies the Complete Genomics reads to be mapped.

    -o--output=DIRSpecifies the directory where results are reported.

    -o

    --output=DIR

    Specifies the directory where results are reported.

     --samSet to output results in SAM format instead of BAM format.

    --sam

    Set to output results in SAM format instead of BAM format.

    -t--template=SDFSpecifies the SDF containing the reference genome to map against.

    -t

    --template=SDF

    Specifies the SDF containing the reference genome to map against.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +threshold will be discarded from the index. (Default is 95%).

    - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --blacklist-threshold=INTfilter k-mers that occur more than this many times in the reference using a blacklist

    --blacklist-threshold=INT

    filter k-mers that occur more than this many times in the reference using a blacklist

     --mask=STRINGRead indexing method. Allowed values are [cg1, cg1-fast, cg2]

    --mask=STRING

    Read indexing method. Allowed values are [cg1, cg1-fast, cg2]

    -M--max-fragment-size=INTThe maximum permitted fragment size when mating paired reads. (Default is 1000).

    -M

    --max-fragment-size=INT

    The maximum permitted fragment size when mating paired reads. (Default is 1000).

    -m--min-fragment-size=INTThe minimum permitted fragment size when mating paired reads. (Default is 0).

    -m

    --min-fragment-size=INT

    The minimum permitted fragment size when mating paired reads. (Default is 0).

    -d--orientation=STRINGOrientation for proper pairs. Allowed values are [fr, rf, tandem, any] (Default is any)

    -d

    --orientation=STRING

    Orientation for proper pairs. Allowed values are [fr, rf, tandem, any] (Default is any)

     --pedigreeGenome relationships pedigree containing sex of sample.

    --pedigree

    Genome relationships pedigree containing sex of sample.

     --penalize-unknownsIf set, will treat unknown bases as mismatches.

    --penalize-unknowns

    If set, will treat unknown bases as mismatches.

     --repeat-freq=INT%Where INT specifies the percentage of all hashes to keep, discarding the remaining percentage of the most frequent +

    --repeat-freq=INT%

    Where INT specifies the percentage of all hashes to keep, discarding the remaining percentage of the most frequent hashes. Increasing this value will improve the ability to map sequences in repetitive regions at a cost of run time. It is also possible to specify the option as an absolute count (by omitting the percent symbol) where any hash exceeding the -threshold will be discarded from the index. (Default is 95%).

     --sex=SEXSex of individual. Allowed values are [male, female, either]

    --sex=SEX

    Sex of individual. Allowed values are [male, female, either]

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Filtering

    Filtering

     --end-read=INTOnly map sequences with sequence id less than the given number. (Sequence ids start at 0).

    --end-read=INT

    Only map sequences with sequence id less than the given number. (Sequence ids start at 0).

     --start-read=INTOnly map sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    --start-read=INT

    Only map sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --all-hitsOutput all alignments meeting thresholds instead of applying mating and N limits.

    --all-hits

    Output all alignments meeting thresholds instead of applying mating and N limits.

    -e--max-mated-mismatches=INTThe maximum mismatches allowed for mated results (as absolute value or percentage of read length). (Default is 10%).

    -e

    --max-mated-mismatches=INT

    The maximum mismatches allowed for mated results (as absolute value or percentage of read length). (Default is 10%).

    -n--max-top-results=INTSets the maximum number of reported mapping results (locations) with the same alignment score (AS). Allowed values are between 1 and 255. (Default is 5).

    -n

    --max-top-results=INT

    Sets the maximum number of reported mapping results (locations) with the same alignment score (AS). Allowed values are between 1 and 255. (Default is 5).

    -E--max-unmated-mismatches=INTThe maximum mismatches allowed for unmated results (as absolute value or percentage of read length). (Default is 10%).

    -E

    --max-unmated-mismatches=INT

    The maximum mismatches allowed for unmated results (as absolute value or percentage of read length). (Default is 10%).

     --sam-rg=STRING|FILESpecifies a file containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:BACT\tPL:COMPLETE.

    --sam-rg=STRING|FILE

    Specifies a file containing a single valid read group SAM header line or a string in the form @RG\tID:RG1\tSM:BACT\tPL:COMPLETE.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

     --legacy-cigarsProduce cigars in legacy format (using M instead of X or =) in SAM/BAM output. When set will also produce the MD field.

    --legacy-cigars

    Produce cigars in legacy format (using M instead of X or =) in SAM/BAM output. When set will also produce the MD field.

     --no-calibrationSet this flag to not produce the calibration output files.

    --no-calibration

    Set this flag to not produce the calibration output files.

    -Z--no-gzipSet this flag to create the SAM output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

    -Z

    --no-gzip

    Set this flag to create the SAM output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

     --no-mergeSet to output mated, unmated and unmapped alignment records into separate SAM/BAM files.

    --no-merge

    Set to output mated, unmated and unmapped alignment records into separate SAM/BAM files.

     --no-svprepDo not perform structural variant processing.

    --no-svprep

    Do not perform structural variant processing.

     --no-unmappedDo not output unmapped reads. Some reads that map multiple times will not be aligned, and are reported as unmapped. These reads are reported with XC attributes that indicate the -reason they were not mapped.

    --no-unmapped

    Do not output unmapped reads. Some reads that map multiple times will not be aligned, and are reported as unmapped. These reads are reported with XC attributes that indicate the +reason they were not mapped.

     --no-unmatedDo not output unmated reads when in paired-end mode.

    --no-unmated

    Do not output unmated reads when in paired-end mode.

     --tempdir=DIRSet the directory to use for temporary files during processing. (Defaults to output directory).

    --tempdir=DIR

    Set the directory to use for temporary files during processing. (Defaults to output directory).

    -T--threads=INTSpecify the number of threads to use in a multi-core processor. (Default is all available cores).

    -T

    --threads=INT

    Specify the number of threads to use in a multi-core processor. (Default is all available cores).

    @@ -2774,8 +2625,8 @@

    cgmap (somewhere between 1 and 2). For version 2 the mask cg2 is approximately equivalent to the mask cg1.

    -

    See also

    -

    map, +

    See also

    +

    map, mapf, mapx

    @@ -2799,123 +2650,123 @@

    coverage +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

     --bedgraphIf set, output in BEDGRAPH format (suppresses BED file output)

    --bedgraph

    If set, output in BEDGRAPH format (suppresses BED file output)

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --per-baseIf set, output per-base counts in TSV format (suppresses BED file output)

    --per-base

    If set, output per-base counts in TSV format (suppresses BED file output)

     --per-regionIf set, output BED/BEDGRAPH entries per-region rather than every coverage level change.

    --per-region

    If set, output BED/BEDGRAPH entries per-region rather than every coverage level change.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --exclude-matedExclude all mated SAM records.

    --exclude-mated

    Exclude all mated SAM records.

     --exclude-unmatedExclude all unmated SAM records.

    --exclude-unmated

    Exclude all unmated SAM records.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

    -m--max-as-mated=INTIf set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -m

    --max-as-mated=INT

    If set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u--max-as-unmated=INTIf set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u

    --max-as-unmated=INT

    If set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -c--max-hits=INTIf set, ignore SAM records with an alignment count that exceeds this value.

    -c

    --max-hits=INT

    If set, ignore SAM records with an alignment count that exceeds this value.

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

    -s--smoothing=INTSmooth with this number of neighboring values (0 means no smoothing) (Default is 50)

    -s

    --smoothing=INT

    Smooth with this number of neighboring values (0 means no smoothing) (Default is 50)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -2945,8 +2796,8 @@

    coverage -

    See also

    -

    map, +

    See also

    +

    map, snp, cnv

    @@ -2969,82 +2820,82 @@

    calibrate +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -m--merge=FILEIf set, merge records and calibration files to this output file.

    -m

    --merge=FILE

    If set, merge records and calibration files to this output file.

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --bed-regions=FILERestrict calibration to mappings falling within the supplied BED regions.

    --bed-regions=FILE

    Restrict calibration to mappings falling within the supplied BED regions.

     --exclude-bed=FILEBED containing regions to exclude from calibration.

    --exclude-bed=FILE

    BED containing regions to exclude from calibration.

     --exclude-vcf=FILEVCF containing sites of known variants to exclude from calibration.

    --exclude-vcf=FILE

    VCF containing sites of known variants to exclude from calibration.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -f--forceForce overwriting of calibration files.

    -f

    --force

    Force overwriting of calibration files.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -3055,8 +2906,8 @@

    calibrate--merge option is used, this command can be used to simultaneously merge input files to a single, calibrated output file.

    -

    See also

    -

    snp, +

    See also

    +

    snp, map, cgmap

    @@ -3083,177 +2934,177 @@

    mapx

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -F--format=FORMATInput format for reads. Allowed values are [sdf, fasta, fastq, sam-se] (Default is sdf)

    -F

    --format=FORMAT

    Input format for reads. Allowed values are [sdf, fasta, fastq, sam-se] (Default is sdf)

    -i--input=SDF|FILEQuery sequences.

    -i

    --input=SDF|FILE

    Query sequences.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -t--template=SDFSDF containing protein database to search.

    -t

    --template=SDF

    SDF containing protein database to search.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

    -c--gap-length=INTGuaranteed number of positions that will be detected in a single gap (Default is 1)

    -c

    --gap-length=INT

    Guaranteed number of positions that will be detected in a single gap (Default is 1)

    -b--gaps=INTGuaranteed minimum number of gaps which will be detected (if this is larger than the minimum number of mismatches then the minimum number of mismatches is -increased to the same value) (Default is 0)

    -b

    --gaps=INT

    Guaranteed minimum number of gaps which will be detected (if this is larger than the minimum number of mismatches then the minimum number of mismatches is +increased to the same value) (Default is 0)

     --matrix=STRINGName of the scoring matrix used during alignment. Allowed values are [blosum45, blosum62, blosum80] (Default is blosum62)

    --matrix=STRING

    Name of the scoring matrix used during alignment. Allowed values are [blosum45, blosum62, blosum80] (Default is blosum62)

     --min-read-length=INTMinimum read length. Shorter reads will be ignored (Default is protein space length of (w + a + 1))

    --min-read-length=INT

    Minimum read length. Shorter reads will be ignored (Default is protein space length of (w + a + 1))

    -a--mismatches=INTGuaranteed minimum number of identical mismatches which will be detected (Default is 1)

    -a

    --mismatches=INT

    Guaranteed minimum number of identical mismatches which will be detected (Default is 1)

     --repeat-freq=INTMaximum repeat frequency (Default is 95%)

    --repeat-freq=INT

    Maximum repeat frequency (Default is 95%)

    -w--word=INTWord size (Default is 7)

    -w

    --word=INT

    Word size (Default is 7)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Filtering

    Filtering

     --end-read=INTExclusive upper bound on read id.

    --end-read=INT

    Exclusive upper bound on read id.

     --start-read=INTInclusive lower bound on read id.

    --start-read=INT

    Inclusive lower bound on read id.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --all-hitsOutput all alignments meeting thresholds instead of applying topn/topequals N limits.

    --all-hits

    Output all alignments meeting thresholds instead of applying topn/topequals N limits.

    -e--max-alignment-score=INTMaximum alignment score at output (as absolute value or percentage of query length in protein space) (Default is 30%)

    -e

    --max-alignment-score=INT

    Maximum alignment score at output (as absolute value or percentage of query length in protein space) (Default is 30%)

    -E--max-e-score=FLOATMaximum e-score at output (Default is 10.0)

    -E

    --max-e-score=FLOAT

    Maximum e-score at output (Default is 10.0)

    -n--max-top-results=INTMaximum number of topn/topequals results output per read (Default is 10)

    -n

    --max-top-results=INT

    Maximum number of topn/topequals results output per read (Default is 10)

    -B--min-bit-score=FLOATMinimum bit score at output.

    -B

    --min-bit-score=FLOAT

    Minimum bit score at output.

    -P--min-identity=INTMinimum percent identity at output (Default is 60)

    -P

    --min-identity=INT

    Minimum percent identity at output (Default is 60)

    -f--output-filter=STRINGOutput filter. Allowed values are [topequal, topn] (Default is topn)

    -f

    --output-filter=STRING

    Output filter. Allowed values are [topequal, topn] (Default is topn)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-unmappedDo not output unmapped reads.

    --no-unmapped

    Do not output unmapped reads.

     --read-namesUse read name in output instead of read id (Uses more RAM)

    --read-names

    Use read name in output instead of read id (Uses more RAM)

     --suppress-proteinDo not include protein sequence in output files.

    --suppress-protein

    Do not include protein sequence in output files.

     --tempdir=DIRDirectory used for temporary files (Defaults to output directory)

    --tempdir=DIR

    Directory used for temporary files (Defaults to output directory)

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -3290,8 +3141,8 @@

    mapxalignments.tsv in the output directory. This ASCII file contains columns of reported data in a format similar to that produced by BLASTX.

    -

    See also

    -

    map, +

    See also

    +

    map, cgmap, mapf, mapp

    @@ -3316,177 +3167,177 @@

    mapp

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -F--format=FORMATInput format for query sequences. Allowed values are [sdf, fasta, fastq, sam-se] (Default is sdf)

    -F

    --format=FORMAT

    Input format for query sequences. Allowed values are [sdf, fasta, fastq, sam-se] (Default is sdf)

    -i--input=SDF|FILEQuery sequences.

    -i

    --input=SDF|FILE

    Query sequences.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -t--template=SDFSDF containing protein database to search.

    -t

    --template=SDF

    SDF containing protein database to search.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

    -c--gap-length=INTGuaranteed number of positions that will be detected in a single gap (Default is 1)

    -c

    --gap-length=INT

    Guaranteed number of positions that will be detected in a single gap (Default is 1)

    -b--gaps=INTGuaranteed minimum number of gaps which will be detected (if this is larger than the minimum number of mismatches then the minimum number of mismatches is -increased to the same value) (Default is 0)

    -b

    --gaps=INT

    Guaranteed minimum number of gaps which will be detected (if this is larger than the minimum number of mismatches then the minimum number of mismatches is +increased to the same value) (Default is 0)

     --matrix=STRINGName of the scoring matrix used during alignment. Allowed values are [blosum45, blosum62, blosum80] (Default is blosum62)

    --matrix=STRING

    Name of the scoring matrix used during alignment. Allowed values are [blosum45, blosum62, blosum80] (Default is blosum62)

     --min-read-length=INTMinimum query sequence length. Shorter query sequences will be ignored (Default is protein space length of (w + a + 1))

    --min-read-length=INT

    Minimum query sequence length. Shorter query sequences will be ignored (Default is protein space length of (w + a + 1))

    -a--mismatches=INTGuaranteed minimum number of identical mismatches which will be detected (Default is 1)

    -a

    --mismatches=INT

    Guaranteed minimum number of identical mismatches which will be detected (Default is 1)

     --repeat-freq=INTMaximum repeat frequency (Default is 95%)

    --repeat-freq=INT

    Maximum repeat frequency (Default is 95%)

    -w--word=INTWord size (Default is 7)

    -w

    --word=INT

    Word size (Default is 7)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Filtering

    Filtering

     --end-read=INTExclusive upper bound on query sequence id.

    --end-read=INT

    Exclusive upper bound on query sequence id.

     --start-read=INTInclusive lower bound on query sequence id.

    --start-read=INT

    Inclusive lower bound on query sequence id.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --all-hitsOutput all alignments meeting thresholds instead of applying topn/topequals N limits.

    --all-hits

    Output all alignments meeting thresholds instead of applying topn/topequals N limits.

    -e--max-alignment-score=INTMaximum alignment score at output (as absolute value or percentage of query length in protein space) (Default is 30%)

    -e

    --max-alignment-score=INT

    Maximum alignment score at output (as absolute value or percentage of query length in protein space) (Default is 30%)

    -E--max-e-score=FLOATMaximum e-score at output (Default is 10.0)

    -E

    --max-e-score=FLOAT

    Maximum e-score at output (Default is 10.0)

    -n--max-top-results=INTMaximum number of topn/topequals results output per query sequence (Default is 10)

    -n

    --max-top-results=INT

    Maximum number of topn/topequals results output per query sequence (Default is 10)

    -B--min-bit-score=FLOATMinimum bit score at output.

    -B

    --min-bit-score=FLOAT

    Minimum bit score at output.

    -P--min-identity=INTMinimum percent identity at output (Default is 60)

    -P

    --min-identity=INT

    Minimum percent identity at output (Default is 60)

    -f--output-filter=STRINGOutput filter. Allowed values are [topequal, topn] (Default is topn)

    -f

    --output-filter=STRING

    Output filter. Allowed values are [topequal, topn] (Default is topn)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-unmappedDo not output unmapped query sequences.

    --no-unmapped

    Do not output unmapped query sequences.

     --read-namesUse query sequence name in output instead of query sequence id (Uses more RAM)

    --read-names

    Use query sequence name in output instead of query sequence id (Uses more RAM)

     --suppress-proteinDo not include protein sequence in output files.

    --suppress-protein

    Do not include protein sequence in output files.

     --tempdir=DIRDirectory used for temporary files (Defaults to output directory)

    --tempdir=DIR

    Directory used for temporary files (Defaults to output directory)

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -3524,8 +3375,8 @@

    mappalignments.tsv in the output directory. This ASCII file contains columns of reported data in a format similar to that produced by BLASTX.

    -

    See also

    -

    map, +

    See also

    +

    map, cgmap, mapf, mapx

    @@ -3572,130 +3423,130 @@

    assemble +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -f--454=DIRSDF containing 454 sequences to assemble. May be specified 0 or more times.

    -f

    --454=DIR

    SDF containing 454 sequences to assemble. May be specified 0 or more times.

    -g--graph=DIRIf you have already constructed an assembly and would like to map additional reads to it or apply some alternate filters you can use this flag to specify the existing graph -directory. You will still need to supply a kmer size to indicate the amount of overlap between contigs.

    -g

    --graph=DIR

    If you have already constructed an assembly and would like to map additional reads to it or apply some alternate filters you can use this flag to specify the existing graph +directory. You will still need to supply a kmer size to indicate the amount of overlap between contigs.

    -F--input-list-454=FILEFile containing a list of SDF directories (1 per line) containing 454 sequences to assemble.

    -F

    --input-list-454=FILE

    File containing a list of SDF directories (1 per line) containing 454 sequences to assemble.

    -I--input-list-file=FILEFile containing a list of SDF directories (1 per line) containing Illumina sequences to assemble.

    -I

    --input-list-file=FILE

    File containing a list of SDF directories (1 per line) containing Illumina sequences to assemble.

    -J--input-list-mate-pair=FILEFile containing a list of SDF directories (1 per line) containing mate pair sequences to assemble.

    -J

    --input-list-mate-pair=FILE

    File containing a list of SDF directories (1 per line) containing mate pair sequences to assemble.

    -j--mate-pairSDF containing mate pair reads. May be specified 0 or more times.

    -j

    --mate-pair

    SDF containing mate pair reads. May be specified 0 or more times.

    -o--output=DIRSpecifies the directory where results are reported.

    -o

    --output=DIR

    Specifies the directory where results are reported.

     SDF+SDF directories containing Illumina sequences to assemble. May be specified 0 or more times.

    SDF+

    SDF directories containing Illumina sequences to assemble. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --consensus-reads=INTWhen using read mappings to disambiguate a graph, paths that are supported by fewer reads than the threshold supplied here will not be collapsed (Default -is 0).

    --consensus-reads=INT

    When using read mappings to disambiguate a graph, paths that are supported by fewer reads than the threshold supplied here will not be collapsed (Default +is 0).

    -k--kmer-size=INTK-mer length to use when constructing a de Bruijn graph.

    -k

    --kmer-size=INT

    K-mer length to use when constructing a de Bruijn graph.

    -M--max-insert=INTMaximum insert size between fragments. (Default is automatically calculated.)

    -M

    --max-insert=INT

    Maximum insert size between fragments. (Default is automatically calculated.)

    -m--min-insert=INTMinimum insert size between fragments. (Default is automatically calculated.)

    -m

    --min-insert=INT

    Minimum insert size between fragments. (Default is automatically calculated.)

    -p--min-path=INTPrior to generating a consensus, long paths will be deleted if they are supported by fewer than ---min-path reads.

    -p

    --min-path=INT

    Prior to generating a consensus, long paths will be deleted if they are supported by fewer than +--min-path reads.

    -c--minimum-kmer-frequency=INTSet minimum k-mer frequency to retain, or -1 for automatic threshold (Default is -1).

    -c

    --minimum-kmer-frequency=INT

    Set minimum k-mer frequency to retain, or -1 for automatic threshold (Default is -1).

    -a--mismatches=INTNumber of bases that may mismatch in an alignment or percentage of read that may mismatch (Default is 0).

    -a

    --mismatches=INT

    Number of bases that may mismatch in an alignment or percentage of read that may mismatch (Default is 0).

     --preserve-bubbles=FLOATAvoid merging bubbles where the ratio of k-mers on the branches is below this (Default is 0.0). This can be used if you wish to preserve diploid -information or some near repeats in graph construction.

    --preserve-bubbles=FLOAT

    Avoid merging bubbles where the ratio of k-mers on the branches is below this (Default is 0.0). This can be used if you wish to preserve diploid +information or some near repeats in graph construction.

    -r--read-count=INTPrior to generating a consensus delete links in the graph that are supported by fewer reads than this threshold.

    -r

    --read-count=INT

    Prior to generating a consensus delete links in the graph that are supported by fewer reads than this threshold.

    -s--step=INTStep size for mapping (Default is 18).

    -s

    --step=INT

    Step size for mapping (Default is 18).

    -w--word=INTWord size for mapping (Default is 18).

    -w

    --word=INT

    Word size for mapping (Default is 18).

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -T--threads=INTSpecify the number of threads to use in a multi-core processor. (Default is all available cores).

    -T

    --threads=INT

    Specify the number of threads to use in a multi-core processor. (Default is all available cores).

    @@ -3775,8 +3626,8 @@

    Consensus -

    See also

    -

    format

    +

    See also

    +

    format

    @@ -3795,53 +3646,53 @@

    addpacbio +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -g--graph=DIRGraph of the assembly to map against.

    -g

    --graph=DIR

    Graph of the assembly to map against.

    -I--input-list-file=FILEFile containing a list of SDF directories (1 per line) containing sequences to assemble.

    -I

    --input-list-file=FILE

    File containing a list of SDF directories (1 per line) containing sequences to assemble.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --trimBefore mapping remove any short disconnected sequences from the graph.

    --trim

    Before mapping remove any short disconnected sequences from the graph.

     SDF+SDF directories containing reads to map. May be specified 0 or more times.

    SDF+

    SDF directories containing reads to map. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -3856,8 +3707,8 @@

    addpacbio -

    See also

    -

    assemble, +

    See also

    +

    assemble, format

    @@ -3888,209 +3739,209 @@

    snp

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --enable-allelic-fractionIf set, incorporate the expected allelic fraction in scoring.

    --enable-allelic-fraction

    If set, incorporate the expected allelic fraction in scoring.

     --exclude-matedExclude all mated SAM records.

    --exclude-mated

    Exclude all mated SAM records.

     --exclude-unmatedExclude all unmated SAM records.

    --exclude-unmated

    Exclude all unmated SAM records.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

    -m--machine-errors=STRINGIf set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

    -m

    --machine-errors=STRING

    If set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

     --max-as-mated=INTIf set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    --max-as-mated=INT

    If set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

     --max-as-unmated=INTIf set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    --max-as-unmated=INT

    If set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

     --max-coverage=INTSkip calling in sites with per sample read depth exceeding this value (Default is 200)

    --max-coverage=INT

    Skip calling in sites with per sample read depth exceeding this value (Default is 200)

     --max-coverage-multiplier=FLOATSkip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

    --max-coverage-multiplier=FLOAT

    Skip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

     --max-hits=INTIf set, ignore SAM records with an alignment count that exceeds this value.

    --max-hits=INT

    If set, ignore SAM records with an alignment count that exceeds this value.

     --min-base-quality=INTPhred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

    --min-base-quality=INT

    Phred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --min-variant-allelic-depth=FLOATIf set, also output sites that meet this minimum quality-adjusted alternate allelic depth.

    --min-variant-allelic-depth=FLOAT

    If set, also output sites that meet this minimum quality-adjusted alternate allelic depth.

     --min-variant-allelic-fraction=FLOATIf set, also output sites that meet this minimum quality-adjusted alternate allelic fraction.

    --min-variant-allelic-fraction=FLOAT

    If set, also output sites that meet this minimum quality-adjusted alternate allelic fraction.

    -p--pedigree=FILEGenome relationships PED file containing sex of individual.

    -p

    --pedigree=FILE

    Genome relationships PED file containing sex of individual.

     --ploidy=STRINGPloidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

    --ploidy=STRING

    Ploidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

     --population-priors=FILEIf set, use the VCF file to generate population based site-specific priors.

    --population-priors=FILE

    If set, use the VCF file to generate population based site-specific priors.

     --rdefault-mated=INTFor mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-mated=INT

    For mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --rdefault-unmated=INTFor unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-unmated=INT

    For unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --sex=SEXSex of individual. Allowed values are [male, female, either] (Default is either)

    --sex=SEX

    Sex of individual. Allowed values are [male, female, either] (Default is either)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -a--allWrite variant calls covering every position irrespective of thresholds.

    -a

    --all

    Write variant calls covering every position irrespective of thresholds.

     --avr-model=MODELName of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path -to a model file (Default is illumina-wgs.avr)

    --avr-model=MODEL

    Name of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path +to a model file (Default is illumina-wgs.avr)

     --filter-ambiguity=INTThreshold for ambiguity filter applied to output variants.

    --filter-ambiguity=INT

    Threshold for ambiguity filter applied to output variants.

     --filter-bed=FILEApply a position based filter, retaining only variants that fall in these BED regions.

    --filter-bed=FILE

    Apply a position based filter, retaining only variants that fall in these BED regions.

     --filter-depth=INTApply a fixed depth of coverage filter to output variants.

    --filter-depth=INT

    Apply a fixed depth of coverage filter to output variants.

     --filter-depth-multiplier=FLOATApply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

    --filter-depth-multiplier=FLOAT

    Apply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

     --snps-onlyIf set, will output simple SNPs only.

    --snps-only

    If set, will output simple SNPs only.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-calibrationIf set, ignore mapping calibration files.

    --no-calibration

    If set, ignore mapping calibration files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -4124,8 +3975,8 @@

    snp
    @@ -4195,8 +4046,8 @@

    Adaptive Variant Rescoring -

    See also

    -

    vcffilter, +

    See also

    +

    vcffilter, vcfannotate, coverage, cnv, @@ -4237,188 +4088,188 @@

    family +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

     --daughter=STRINGSample identifier used in read groups for a daughter sample. May be specified 0 or more times.

    --daughter=STRING

    Sample identifier used in read groups for a daughter sample. May be specified 0 or more times.

     --father=STRINGSample identifier used in read groups for father sample.

    --father=STRING

    Sample identifier used in read groups for father sample.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

     --mother=STRINGSample identifier used in read groups for for mother sample.

    --mother=STRING

    Sample identifier used in read groups for for mother sample.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -p--pedigree=FILEGenome relationships PED file, if not specifying family via –father, –mother, etc.

    -p

    --pedigree=FILE

    Genome relationships PED file, if not specifying family via –father, –mother, etc.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

     --son=STRINGSample identifier used in read groups for a son sample. May be specified 0 or more times.

    --son=STRING

    Sample identifier used in read groups for a son sample. May be specified 0 or more times.

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --enable-allelic-fractionIf set, incorporate the expected allelic fraction in scoring.

    --enable-allelic-fraction

    If set, incorporate the expected allelic fraction in scoring.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

    -m--machine-errors=STRINGIf set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

    -m

    --machine-errors=STRING

    If set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

     --max-coverage=INTSkip calling in sites with per sample read depth exceeding this value (Default is 200)

    --max-coverage=INT

    Skip calling in sites with per sample read depth exceeding this value (Default is 200)

     --max-coverage-multiplier=FLOATSkip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

    --max-coverage-multiplier=FLOAT

    Skip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

     --min-base-quality=INTPhred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

    --min-base-quality=INT

    Phred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --population-priors=FILEIf set, use the VCF file to generate population based site-specific priors.

    --population-priors=FILE

    If set, use the VCF file to generate population based site-specific priors.

     --rdefault-mated=INTFor mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-mated=INT

    For mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --rdefault-unmated=INTFor unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-unmated=INT

    For unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -a--allWrite variant calls covering every position irrespective of thresholds.

    -a

    --all

    Write variant calls covering every position irrespective of thresholds.

     --avr-model=MODELName of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path to a model file (Default is illumina-wgs.avr)

    --avr-model=MODEL

    Name of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path to a model file (Default is illumina-wgs.avr)

     --filter-ambiguity=INTThreshold for ambiguity filter applied to output variants.

    --filter-ambiguity=INT

    Threshold for ambiguity filter applied to output variants.

     --filter-bed=FILEApply a position based filter, retaining only variants that fall in these BED regions.

    --filter-bed=FILE

    Apply a position based filter, retaining only variants that fall in these BED regions.

     --filter-depth=INTApply a fixed depth of coverage filter to output variants.

    --filter-depth=INT

    Apply a fixed depth of coverage filter to output variants.

     --filter-depth-multiplier=FLOATApply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

    --filter-depth-multiplier=FLOAT

    Apply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

     --snps-onlyIf set, will output simple SNPs only.

    --snps-only

    If set, will output simple SNPs only.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-calibrationIf set, ignore mapping calibration files.

    --no-calibration

    If set, ignore mapping calibration files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -4462,8 +4313,8 @@

    familysnp command in snp.

    -

    See also

    -

    snp, +

    See also

    +

    snp, somatic, population, calibrate

    @@ -4472,7 +4323,9 @@

    family

    somatic

    Synopsis:

    -

    The somatic command calls sequence variants on an original and derived sample set.

    +

    The somatic command calls sequence variants on an original and +derived sample set. If no normal sample is available, it is possible +to use the tumoronly command instead.

    Syntax:

    Multi-file input specified from command line:

    $ rtg somatic [OPTION]... -o DIR -t SDF --contamination FLOAT --derived STRING \
    @@ -4490,217 +4343,217 @@ 

    somatic +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

     --derived=STRINGSample identifier used in read groups for derived sample.

    --derived=STRING

    Sample identifier used in read groups for derived sample.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

     --original=STRINGSample identifier used in read groups for original sample.

    --original=STRING

    Sample identifier used in read groups for original sample.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --contamination=FLOATEstimated fraction of contamination in derived sample.

    --contamination=FLOAT

    Estimated fraction of contamination in derived sample.

     --enable-allelic-fractionIf set, incorporate the expected allelic fraction in scoring.

    --enable-allelic-fraction

    If set, incorporate the expected allelic fraction in scoring.

     --enable-somatic-allelic-fractionIf set, incorporate the expected somatic allelic fraction in scoring.

    --enable-somatic-allelic-fraction

    If set, incorporate the expected somatic allelic fraction in scoring.

    -G--include-gain-of-referenceInclude gain of reference somatic calls in output VCF.

    -G

    --include-gain-of-reference

    Include gain of reference somatic calls in output VCF.

     --include-germlineInclude germline variants in output VCF.

    --include-germline

    Include germline variants in output VCF.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

     --loh=FLOATPrior probability that a loss of heterozygosity event has occurred (Default is 0.0)

    --loh=FLOAT

    Prior probability that a loss of heterozygosity event has occurred (Default is 0.0)

    -m--machine-errors=STRINGIf set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

    -m

    --machine-errors=STRING

    If set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

     --max-coverage=INTSkip calling in sites with per sample read depth exceeding this value (Default is 200)

    --max-coverage=INT

    Skip calling in sites with per sample read depth exceeding this value (Default is 200)

     --max-coverage-multiplier=FLOATSkip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 25.0)

    --max-coverage-multiplier=FLOAT

    Skip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 25.0)

     --min-base-quality=INTPhred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

    --min-base-quality=INT

    Phred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --min-variant-allelic-depth=FLOATIf set, also output sites that meet this minimum quality-adjusted alternate allelic depth.

    --min-variant-allelic-depth=FLOAT

    If set, also output sites that meet this minimum quality-adjusted alternate allelic depth.

     --min-variant-allelic-fraction=FLOATIf set, also output sites that meet this minimum quality-adjusted alternate allelic fraction.

    --min-variant-allelic-fraction=FLOAT

    If set, also output sites that meet this minimum quality-adjusted alternate allelic fraction.

     --population-priors=FILEIf set, use the VCF file to generate population based site-specific priors.

    --population-priors=FILE

    If set, use the VCF file to generate population based site-specific priors.

     --rdefault-mated=INTFor mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-mated=INT

    For mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --rdefault-unmated=INTFor unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-unmated=INT

    For unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --sex=SEXSex of individual. Allowed values are [male, female, either] (Default is either)

    --sex=SEX

    Sex of individual. Allowed values are [male, female, either] (Default is either)

    -s--somatic=FLOATDefault prior probability of a somatic SNP mutation in the derived sample (Default is 0.000001)

    -s

    --somatic=FLOAT

    Default prior probability of a somatic SNP mutation in the derived sample (Default is 0.000001)

     --somatic-priors=FILEIf set, use the BED file to generate site specific somatic priors.

    --somatic-priors=FILE

    If set, use the BED file to generate site specific somatic priors.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -a--allWrite variant calls covering every position irrespective of thresholds.

    -a

    --all

    Write variant calls covering every position irrespective of thresholds.

     --avr-model=MODELName of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path -to a model file (Default is illumina-somatic.avr)

    --avr-model=MODEL

    Name of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path +to a model file (Default is illumina-somatic.avr)

     --filter-ambiguity=INTThreshold for ambiguity filter applied to output variants.

    --filter-ambiguity=INT

    Threshold for ambiguity filter applied to output variants.

     --filter-bed=FILEApply a position based filter, retaining only variants that fall in these BED regions.

    --filter-bed=FILE

    Apply a position based filter, retaining only variants that fall in these BED regions.

     --filter-depth=INTApply a fixed depth of coverage filter to output variants.

    --filter-depth=INT

    Apply a fixed depth of coverage filter to output variants.

     --filter-depth-multiplier=FLOATApply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

    --filter-depth-multiplier=FLOAT

    Apply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

     --snps-onlyIf set, will output simple SNPs only.

    --snps-only

    If set, will output simple SNPs only.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-calibrationIf set, ignore mapping calibration files.

    --no-calibration

    If set, ignore mapping calibration files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -4750,9 +4603,9 @@

    somatic--loh parameter is used to control the sensitivity to variants occurring in regions of loss of heterozygosity. In heterozygous -regions, a somatic mutation of the form XY \rightarrow ZZ -(with X \neq Z and Y \neq Z ) is extremely unlikely; -however, in a loss of heterozygosity region, XY \rightarrow Z +regions, a somatic mutation of the form XY \rightarrow ZZ +(with X \neq Z and Y \neq Z ) is extremely unlikely; +however, in a loss of heterozygosity region, XY \rightarrow Z is plausible. As the loss of heterozygosity prior is increased, the barrier to detecting and reporting such variants is reduced. If a region is known or suspected to have a loss of heterozygosity, then a @@ -4763,8 +4616,8 @@

    somaticsnp command in snp.

    -

    See also

    -

    snp, +

    See also

    +

    snp, family, population, calibrate, @@ -4789,211 +4642,211 @@

    tumoronly +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=STRINGIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:start-end or <sequence_name>:start+length.

    --region=STRING

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:start-end or <sequence_name>:start+length.

     --sample=STRINGSample identifier used in read groups for tumor sample.

    --sample=STRING

    Sample identifier used in read groups for tumor sample.

    -t--template=SDFSDF of the reference genome the reads have been mapped against.

    -t

    --template=SDF

    SDF of the reference genome the reads have been mapped against.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --contamination=FLOATEstimated fraction of contamination in derived sample (Default is 0.75)

    --contamination=FLOAT

    Estimated fraction of contamination in derived sample (Default is 0.75)

     --enable-allelic-fractionIf set, incorporate the expected allelic fraction in scoring.

    --enable-allelic-fraction

    If set, incorporate the expected allelic fraction in scoring.

     --enable-somatic-allelic-fractionIf set, incorporate the expected somatic allelic fraction in scoring.

    --enable-somatic-allelic-fraction

    If set, incorporate the expected somatic allelic fraction in scoring.

    -G--include-gain-of-referenceInclude gain of reference somatic calls in output VCF.

    -G

    --include-gain-of-reference

    Include gain of reference somatic calls in output VCF.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

     --loh=FLOATPrior probability that a loss of heterozygosity event has occurred (Default is 0.0)

    --loh=FLOAT

    Prior probability that a loss of heterozygosity event has occurred (Default is 0.0)

    -m--machine-errors=STRINGIf set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

    -m

    --machine-errors=STRING

    If set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

     --max-coverage=INTSkip calling in sites with per sample read depth exceeding this value (Default is 200)

    --max-coverage=INT

    Skip calling in sites with per sample read depth exceeding this value (Default is 200)

     --max-coverage-multiplier=FLOATSkip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 25.0)

    --max-coverage-multiplier=FLOAT

    Skip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 25.0)

     --min-base-quality=INTPhred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

    --min-base-quality=INT

    Phred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --min-variant-allelic-depth=FLOATIf set, also output sites that meet this minimum quality-adjusted alternate allelic depth.

    --min-variant-allelic-depth=FLOAT

    If set, also output sites that meet this minimum quality-adjusted alternate allelic depth.

     --min-variant-allelic-fraction=FLOATIf set, also output sites that meet this minimum quality-adjusted alternate allelic fraction.

    --min-variant-allelic-fraction=FLOAT

    If set, also output sites that meet this minimum quality-adjusted alternate allelic fraction.

     --population-priors=FILEIf set, use the VCF file to generate population based site-specific priors.

    --population-priors=FILE

    If set, use the VCF file to generate population based site-specific priors.

     --rdefault-mated=INTFor mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-mated=INT

    For mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --rdefault-unmated=INTFor unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-unmated=INT

    For unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --sex=SEXSex of individual. Allowed values are [male, female, either] (Default is either)

    --sex=SEX

    Sex of individual. Allowed values are [male, female, either] (Default is either)

    -s--somatic=FLOATDefault prior probability of a somatic SNP mutation in the derived sample (Default is 0.000001)

    -s

    --somatic=FLOAT

    Default prior probability of a somatic SNP mutation in the derived sample (Default is 0.000001)

     --somatic-priors=FILEIf set, use the BED file to generate site specific somatic priors.

    --somatic-priors=FILE

    If set, use the BED file to generate site specific somatic priors.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -a--allWrite variant calls covering every position irrespective of thresholds.

    -a

    --all

    Write variant calls covering every position irrespective of thresholds.

     --avr-model=MODELName of AVR model to use when scoring variants.

    --avr-model=MODEL

    Name of AVR model to use when scoring variants.

     --filter-ambiguity=INTThreshold for ambiguity filter applied to output variants.

    --filter-ambiguity=INT

    Threshold for ambiguity filter applied to output variants.

     --filter-bed=FILEApply a position based filter, retaining only variants that fall in these BED regions.

    --filter-bed=FILE

    Apply a position based filter, retaining only variants that fall in these BED regions.

     --filter-depth=INTApply a fixed depth of coverage filter to output variants.

    --filter-depth=INT

    Apply a fixed depth of coverage filter to output variants.

     --filter-depth-multiplier=FLOATApply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

    --filter-depth-multiplier=FLOAT

    Apply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

     --snps-onlyIf set, will output simple SNPs only.

    --snps-only

    If set, will output simple SNPs only.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-calibrationIf set, ignore mapping calibration files.

    --no-calibration

    If set, ignore mapping calibration files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-indexDo not produce indexes for output files.

    --no-index

    Do not produce indexes for output files.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -5022,8 +4875,8 @@

    tumoronlysomatic command in somatic.

    -

    See also

    -

    snp, +

    See also

    +

    snp, somatic

    @@ -5046,181 +4899,181 @@

    population +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -p--pedigree=FILEGenome relationships PED file.

    -p

    --pedigree=FILE

    Genome relationships PED file.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --enable-allelic-fractionIf set, incorporate the expected allelic fraction in scoring.

    --enable-allelic-fraction

    If set, incorporate the expected allelic fraction in scoring.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

    -m--machine-errors=STRINGIf set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

    -m

    --machine-errors=STRING

    If set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

     --max-coverage=INTSkip calling in sites with per sample read depth exceeding this value (Default is 200)

    --max-coverage=INT

    Skip calling in sites with per sample read depth exceeding this value (Default is 200)

     --max-coverage-multiplier=FLOATSkip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

    --max-coverage-multiplier=FLOAT

    Skip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

     --min-base-quality=INTPhred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

    --min-base-quality=INT

    Phred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --pedigree-connectivity=STRINGSets mode of operation based on how well connected the pedigree is. Allowed values are [auto, sparse, dense] (Default is auto)

    --pedigree-connectivity=STRING

    Sets mode of operation based on how well connected the pedigree is. Allowed values are [auto, sparse, dense] (Default is auto)

     --population-priors=FILEIf set, use the VCF file to generate population based site-specific priors.

    --population-priors=FILE

    If set, use the VCF file to generate population based site-specific priors.

     --rdefault-mated=INTFor mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-mated=INT

    For mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --rdefault-unmated=INTFor unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-unmated=INT

    For unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -a--allWrite variant calls covering every position irrespective of thresholds.

    -a

    --all

    Write variant calls covering every position irrespective of thresholds.

     --avr-model=MODELName of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path -to a model file (Default is illumina-wgs.avr)

    --avr-model=MODEL

    Name of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path +to a model file (Default is illumina-wgs.avr)

     --filter-ambiguity=INTThreshold for ambiguity filter applied to output variants.

    --filter-ambiguity=INT

    Threshold for ambiguity filter applied to output variants.

     --filter-bed=FILEApply a position based filter, retaining only variants that fall in these BED regions.

    --filter-bed=FILE

    Apply a position based filter, retaining only variants that fall in these BED regions.

     --filter-depth=INTApply a fixed depth of coverage filter to output variants.

    --filter-depth=INT

    Apply a fixed depth of coverage filter to output variants.

     --filter-depth-multiplier=FLOATApply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

    --filter-depth-multiplier=FLOAT

    Apply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

     --impute=STRINGName of sample absent from mappings to impute genotype for. May be specified 0 or more times, or as a comma separated list.

    --impute=STRING

    Name of sample absent from mappings to impute genotype for. May be specified 0 or more times, or as a comma separated list.

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

     --snps-onlyIf set, will output simple SNPs only.

    --snps-only

    If set, will output simple SNPs only.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-calibrationIf set, ignore mapping calibration files.

    --no-calibration

    If set, ignore mapping calibration files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -5293,8 +5146,8 @@

    populationsnp command in snp.

    -

    See also

    -

    snp, +

    See also

    +

    snp, family, somatic, calibrate

    @@ -5319,172 +5172,172 @@

    lineage +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -p--pedigree=FILEGenome relationships PED file.

    -p

    --pedigree=FILE

    Genome relationships PED file.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --enable-allelic-fractionIf set, incorporate the expected allelic fraction in scoring.

    --enable-allelic-fraction

    If set, incorporate the expected allelic fraction in scoring.

     --keep-duplicatesDon’t detect and filter duplicate reads based on mapping position.

    --keep-duplicates

    Don’t detect and filter duplicate reads based on mapping position.

    -m--machine-errors=STRINGIf set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

    -m

    --machine-errors=STRING

    If set, force sequencer machine settings. Allowed values are [default, illumina, ls454_se, ls454_pe, complete, iontorrent]

     --max-coverage=INTSkip calling in sites with per sample read depth exceeding this value (Default is 200)

    --max-coverage=INT

    Skip calling in sites with per sample read depth exceeding this value (Default is 200)

     --max-coverage-multiplier=FLOATSkip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

    --max-coverage-multiplier=FLOAT

    Skip calling in sites with combined depth exceeding multiplier * average combined coverage determined from calibration (Default is 5.0)

     --min-base-quality=INTPhred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

    --min-base-quality=INT

    Phred scaled quality score, read bases below this quality will be treated as unknowns (Default is 0)

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --population-priors=FILEIf set, use the VCF file to generate population based site-specific priors.

    --population-priors=FILE

    If set, use the VCF file to generate population based site-specific priors.

     --rdefault-mated=INTFor mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-mated=INT

    For mated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

     --rdefault-unmated=INTFor unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    --rdefault-unmated=INT

    For unmated reads that have no mapping quality supplied use this as the default quality (in Phred format from 0 to 63) (Default is 20)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -a--allWrite variant calls covering every position irrespective of thresholds.

    -a

    --all

    Write variant calls covering every position irrespective of thresholds.

     --avr-model=MODELName of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path to a model file (Default is illumina-wgs.avr)

    --avr-model=MODEL

    Name of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path to a model file (Default is illumina-wgs.avr)

     --filter-ambiguity=INTThreshold for ambiguity filter applied to output variants.

    --filter-ambiguity=INT

    Threshold for ambiguity filter applied to output variants.

     --filter-bed=FILEApply a position based filter, retaining only variants that fall in these BED regions.

    --filter-bed=FILE

    Apply a position based filter, retaining only variants that fall in these BED regions.

     --filter-depth=INTApply a fixed depth of coverage filter to output variants.

    --filter-depth=INT

    Apply a fixed depth of coverage filter to output variants.

     --filter-depth-multiplier=FLOATApply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

    --filter-depth-multiplier=FLOAT

    Apply a ratio based depth filter. The filter will be multiplier * average coverage determined from calibration files.

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

     --snps-onlyIf set, will output simple SNPs only.

    --snps-only

    If set, will output simple SNPs only.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-calibrationIf set, ignore mapping calibration files.

    --no-calibration

    If set, ignore mapping calibration files.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -5515,8 +5368,8 @@

    lineagesnp command in snp.

    -

    See also

    -

    snp, +

    See also

    +

    snp, family, somatic, population, @@ -5537,74 +5390,74 @@

    avrpredict +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILEInput VCF file containing variants to score. Use ‘-‘ to read from standard input.

    -i

    --input=FILE

    Input VCF file containing variants to score. Use ‘-‘ to read from standard input.

    -o--output=FILEOutput VCF file. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output VCF file. Use ‘-‘ to write to standard output.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --avr-model=MODELName of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path to a model file (Default is illumina-wgs.avr)

    --avr-model=MODEL

    Name of AVR model to use when scoring variants. Allowed values are [alternate.avr, illumina-exome.avr, illumina-somatic.avr, illumina-wgs.avr, none] or a path to a model file (Default is illumina-wgs.avr)

     --min-avr-score=FLOATIf set, fail variants with AVR scores below this value.

    --min-avr-score=FLOAT

    If set, fail variants with AVR scores below this value.

    -s--sample=STRINGIf set, only re-score the specified samples (Default is to re-score all samples). May be specified 0 or more times.

    -s

    --sample=STRING

    If set, only re-score the specified samples (Default is to re-score all samples). May be specified 0 or more times.

    -f--vcf-score-field=STRINGThe name of the VCF FORMAT field in which to store the computed score (Default is AVR)

    -f

    --vcf-score-field=STRING

    The name of the VCF FORMAT field in which to store the computed score (Default is AVR)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    @@ -5621,8 +5474,8 @@

    avrpredict -

    See also

    -

    avrbuild, +

    See also

    +

    avrbuild, avrstats, snp, family, @@ -5643,91 +5496,91 @@

    avrbuild +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -a--annotated=FILEVCF file containing training examples annotated with CALL=TP/FP. May be specified 0 or more times.

    -a

    --annotated=FILE

    VCF file containing training examples annotated with CALL=TP/FP. May be specified 0 or more times.

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -n--negative=FILEVCF file containing negative training examples. May be specified 0 or more times.

    -n

    --negative=FILE

    VCF file containing negative training examples. May be specified 0 or more times.

    -o--output=FILEOutput AVR model.

    -o

    --output=FILE

    Output AVR model.

    -p--positive=FILEVCF file containing positive training examples. May be specified 0 or more times.

    -p

    --positive=FILE

    VCF file containing positive training examples. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --derived-annotations=STRINGDerived fields to use in model. Allowed values are [IC, EP, LAL, QD, NAA, AN, GQD, VAF1, ZY, PD, MEANQAD, QA, RA]. May be specified 0 or more times, or as a -comma separated list.

    --derived-annotations=STRING

    Derived fields to use in model. Allowed values are [IC, EP, LAL, QD, NAA, AN, GQD, VAF1, ZY, PD, MEANQAD, QA, RA]. May be specified 0 or more times, or as a +comma separated list.

     --format-annotations=STRINGFORMAT fields to use in model. May be specified 0 or more times, or as a comma separated list.

    --format-annotations=STRING

    FORMAT fields to use in model. May be specified 0 or more times, or as a comma separated list.

     --info-annotations=STRINGINFO fields to use in model. May be specified 0 or more times, or as a comma separated list.

    --info-annotations=STRING

    INFO fields to use in model. May be specified 0 or more times, or as a comma separated list.

     --qual-annotationIf set, use QUAL annotation in model.

    --qual-annotation

    If set, use QUAL annotation in model.

    -s--sample=STRINGThe name of the sample to select (required when using multi-sample VCF files)

    -s

    --sample=STRING

    The name of the sample to select (required when using multi-sample VCF files)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -5753,8 +5606,8 @@

    avrbuild -

    See also

    -

    avrpredict, +

    See also

    +

    avrpredict, avrstats, snp, family, @@ -5777,41 +5630,41 @@

    svprep +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

     DIRSpecifies the directory containing SAM/BAM format files for preparation.

    DIR

    Specifies the directory containing SAM/BAM format files for preparation.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-augmentIf set, only compute read group statistics.

    --no-augment

    If set, only compute read group statistics.

    @@ -5819,17 +5672,17 @@

    svprepsvprep command to prepare mappings for structural variant analysis. The svprep command performs three functions:

      -
    • First, it identifies discordant reads (those were there exists a +
    • First, it identifies discordant reads (those were there exists a unique unmated mapping for each arm of a paired-end) and fills in the RNEXT/PNEXT/TLEN fields for these records. The augmented unmated -SAM/BAM file will replace the original.

    • -
    • Secondly it identifies unmapped reads for which there exists a unique +SAM/BAM file will replace the original.

    • +
    • Secondly it identifies unmapped reads for which there exists a unique unmated mapping for the other arm and fills in an estimated position for the unmapped read. The augmented unmapped SAM/BAM file will -replace the original.

    • -
    • Thirdly it generates per read-group statistics on observed length +replace the original.

    • +
    • Thirdly it generates per read-group statistics on observed length distributions used by subsequent structural variant analysis -tools.

    • +tools.

    svprep may be instructed to perform only the last of these functions via the --no-augment flag.

    @@ -5837,8 +5690,8 @@

    svprep -

    See also

    -

    map, +

    See also

    +

    map, sv, discord

    @@ -5862,111 +5715,111 @@

    discord +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bedProduce output in BED format in addition to VCF.

    --bed

    Produce output in BED format in addition to VCF.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -r--readgroup-stats=FILEText file containing read group stats. May be specified 0 or more times.

    -r

    --readgroup-stats=FILE

    Text file containing read group stats. May be specified 0 or more times.

    -R--readgroup-stats-list-file=FILEFile containing list of read group stats files (1 per line)

    -R

    --readgroup-stats-list-file=FILE

    File containing list of read group stats files (1 per line)

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --consistent-onlyOnly include breakends with internally consistent supporting reads.

    --consistent-only

    Only include breakends with internally consistent supporting reads.

    -m--max-as-mated=INTIf set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -m

    --max-as-mated=INT

    If set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u--max-as-unmated=INTIf set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u

    --max-as-unmated=INT

    If set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -c--max-hits=INTIf set, ignore SAM records with an alignment count that exceeds this value.

    -c

    --max-hits=INT

    If set, ignore SAM records with an alignment count that exceeds this value.

    -s--min-support=INTMinimum number of supporting reads for a breakend (Default is 3)

    -s

    --min-support=INT

    Minimum number of supporting reads for a breakend (Default is 3)

     --overlap-fraction=FLOATAssume this fraction of an aligned ready may may overlap a breakend (Default is 0.01)

    --overlap-fraction=FLOAT

    Assume this fraction of an aligned ready may may overlap a breakend (Default is 0.01)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -Z--no-gzipSet this flag to create the output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

    -Z

    --no-gzip

    Set this flag to create the output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

    -T--threads=INTSpecify the number of threads to use in a multi-core processor. (Default is all available cores).

    -T

    --threads=INT

    Specify the number of threads to use in a multi-core processor. (Default is all available cores).

    @@ -5991,8 +5844,8 @@

    discorddiscord command output files see Discord command output file descriptions.

    -

    See also

    -

    svprep, +

    See also

    +

    svprep, sv

    @@ -6014,107 +5867,107 @@

    sv

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --readgroup-labels=FILEFile containing read group relabel mappings (1 per line with the format: [input_readgroup_id][tab][output_readgroup_id]).

    --readgroup-labels=FILE

    File containing read group relabel mappings (1 per line with the format: [input_readgroup_id][tab][output_readgroup_id]).

    -r--readgroup-stats=FILEText file containing read group stats. May be specified 0 or more times.

    -r

    --readgroup-stats=FILE

    Text file containing read group stats. May be specified 0 or more times.

    -R--readgroup-stats-list-file=FILEFile containing list of read group stats files (1 per line)

    -R

    --readgroup-stats-list-file=FILE

    File containing list of read group stats files (1 per line)

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

     --simple-signalsIf set, also output simple signals.

    --simple-signals

    If set, also output simple signals.

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

    -f--fine-step=INTSet the step size in interesting regions. (Default is 10).

    -f

    --fine-step=INT

    Set the step size in interesting regions. (Default is 10).

    -m--max-as-mated=INTSet to ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -m

    --max-as-mated=INT

    Set to ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u--max-as-unmated=INTSet to ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u

    --max-as-unmated=INT

    Set to ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -s--step=INTSet the step size. (Default is 100).

    -s

    --step=INT

    Set the step size. (Default is 100).

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -Z--no-gzipSet this flag to create the output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

    -Z

    --no-gzip

    Set this flag to create the output files without compression. By default the output files are compressed with tabix compatible blocked gzip.

    -T--threads=INTSpecify the number of threads to use in a multi-core processor. (Default is all available cores).

    -T

    --threads=INT

    Specify the number of threads to use in a multi-core processor. (Default is all available cores).

    @@ -6128,43 +5981,43 @@

    sv sv_bayesian.tsv.gz is a tab separated format that contains the prediction strengths of each event model.

    Table : Bayesian SV indicators

    - +
    --++ - - - + + + - - - + + + - - + + - - + + - - + + - - + + - - + + - - + + - - + + - - + +
    IndicatorDescription

    Indicator

    Description

    normalNo structural variant.

    normal

    No structural variant.

    duplicate-leftThe left border of a duplication.

    duplicate-left

    The left border of a duplication.

    duplicatePosition within a duplicated region.

    duplicate

    Position within a duplicated region.

    duplicate-rightThe right border of a duplication.

    duplicate-right

    The right border of a duplication.

    delete-leftThe left border of a deletion.

    delete-left

    The left border of a deletion.

    deletePosition within a deletion.

    delete

    Position within a deletion.

    delete-rightThe right border of a deletion.

    delete-right

    The right border of a deletion.

    breakpointA breakpoint such as at the site where a duplicated section is inserted.

    breakpoint

    A breakpoint such as at the site where a duplicated section is inserted.

    novel-insertionA site receiving a novel insertion.

    novel-insertion

    A site receiving a novel insertion.

    @@ -6184,8 +6037,8 @@

    sv

    For additional information about the sv command output files see SV command output file descriptions.

    -

    See also

    -

    svprep, +

    See also

    +

    svprep, discord

    @@ -6210,113 +6063,113 @@

    cnv

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--base-file=FILESAM/BAM format files containing mapped reads for baseline. May be specified 0 or more times.

    -i

    --base-file=FILE

    SAM/BAM format files containing mapped reads for baseline. May be specified 0 or more times.

    -I--base-list-file=FILEFile containing list of SAM/BAM format files (1 per line) containing mapped reads for baseline.

    -I

    --base-list-file=FILE

    File containing list of SAM/BAM format files (1 per line) containing mapped reads for baseline.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

    -j--test-file=FILESAM/BAM format files containing mapped reads for test. May be specified 0 or more times.

    -j

    --test-file=FILE

    SAM/BAM format files containing mapped reads for test. May be specified 0 or more times.

    -J--test-list-file=FILEFile containing list of SAM/BAM format files (1 per line) containing mapped reads for test.

    -J

    --test-list-file=FILE

    File containing list of SAM/BAM format files (1 per line) containing mapped reads for test.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

    -b--bucket-size=INTSet size of the buckets in the genome. Use the bucket size to determine CNV coverage, bucket size defines the number of nucleotides to average the -coverage for in a region. (Default is 100)

    -b

    --bucket-size=INT

    Set size of the buckets in the genome. Use the bucket size to determine CNV coverage, bucket size defines the number of nucleotides to average the +coverage for in a region. (Default is 100)

     --exclude-matedSet to exclude all mated SAM records.

    --exclude-mated

    Set to exclude all mated SAM records.

     --exclude-unmatedSet to exclude all unmated SAM records.

    --exclude-unmated

    Set to exclude all unmated SAM records.

    -m--max-as-mated=INTSet to ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -m

    --max-as-mated=INT

    Set to ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u--max-as-unmated=INTSet to ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u

    --max-as-unmated=INT

    Set to ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -c--max-hits=INTSet to ignore SAM records with an alignment count that exceeds this value. This flag is usually set to 1 because an alignment count of 1 represents -uniquely mapped reads.

    -c

    --max-hits=INT

    Set to ignore SAM records with an alignment count that exceeds this value. This flag is usually set to 1 because an alignment count of 1 represents +uniquely mapped reads.

     --min-mapq=INTSet to ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    Set to ignore SAM records with MAPQ less than this value.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -6329,8 +6182,8 @@

    cnv @@ -6355,107 +6208,107 @@

    species +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -t--genomes=SDFSDF containing the genomes.

    -t

    --genomes=SDF

    SDF containing the genomes.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -r--relabel-species-file=FILEFile containing list of species name to reference name mappings (1 mapping per line format: [reference short name][tab][species])

    -r

    --relabel-species-file=FILE

    File containing list of species name to reference name mappings (1 mapping per line format: [reference short name][tab][species])

     FILE+SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --exclude-matedExclude all mated SAM records.

    --exclude-mated

    Exclude all mated SAM records.

     --exclude-unmatedExclude all unmated SAM records.

    --exclude-unmated

    Exclude all unmated SAM records.

    -m--max-as-mated=INTIf set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -m

    --max-as-mated=INT

    If set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u--max-as-unmated=INTIf set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u

    --max-as-unmated=INT

    If set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Reporting

    Reporting

    -c--min-confidence=FLOATSpecies below this confidence value will not be reported (Default is 10.0)

    -c

    --min-confidence=FLOAT

    Species below this confidence value will not be reported (Default is 10.0)

     --print-allPrint non present species in the output file.

    --print-all

    Print non present species in the output file.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -6495,11 +6348,11 @@

    species “. For an alternative -hypothesis, corresponding to “species not present”, another posterior, P' , +null hypothesis “species present at level P “. For an alternative +hypothesis, corresponding to “species not present”, another posterior, P' , is computed by forcing the estimated abundance for that species to 0. -Confidence is then the log ratio of the two values, C=ln({ \frac {P'} {P} }) . The number -reported in the confidence column is \sqrt{C} . Taking the square root makes +Confidence is then the log ratio of the two values, C=ln({ \frac {P'} {P} }) . The number +reported in the confidence column is \sqrt{C} . Taking the square root makes the units of confidence standard deviations and reduces the spread of values. By adjusting the --min-confidence parameter you can allow only results with a higher confidence to be output.

    @@ -6508,8 +6361,8 @@

    species -

    See also

    -

    similarity

    +

    See also

    +

    similarity

    @@ -6531,74 +6384,74 @@

    similarity +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILESpecifies a file containing a labeled list of SDFs (one label and SDF per line format: [label][space][SDF])

    -I

    --input-list-file=FILE

    Specifies a file containing a labeled list of SDFs (one label and SDF per line format: [label][space][SDF])

    -i--input=SDFSpecifies the SDF containing a subject data set.

    -i

    --input=SDF

    Specifies the SDF containing a subject data set.

    -o--output=DIRSpecifies the directory where results are reported.

    -o

    --output=DIR

    Specifies the directory where results are reported.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

    -s--step=INTSet the step size. (Default is 1).

    -s

    --step=INT

    Set the step size. (Default is 1).

     --unique-wordsSet to count only unique words.

    --unique-words

    Set to count only unique words.

    -w--word=INTSet the word size. (Default is 25).

    -w

    --word=INT

    Set the word size. (Default is 25).

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --max-reads=INTSet the maximum number of reads to use from each input SDF. Use to reduce memory requirements in multi-file mode.

    --max-reads=INT

    Set the maximum number of reads to use from each input SDF. Use to reduce memory requirements in multi-file mode.

    @@ -6624,8 +6477,8 @@

    similaritySpecies results file description.

    -

    See also

    -

    species

    +

    See also

    +

    species

    @@ -6654,61 +6507,61 @@

    composition-meta-pipeline +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --filter=SDFSpecifies the SDF containing the filter reference sequences.

    --filter=SDF

    Specifies the SDF containing the filter reference sequences.

     --input=SDF|FILESpecifies the path to the reads to be processed.

    --input=SDF|FILE

    Specifies the path to the reads to be processed.

     --input-left=FILEThe left input file for FASTQ paired end reads.

    --input-left=FILE

    The left input file for FASTQ paired end reads.

     --input-right=FILEThe right input file for FASTQ paired end reads.

    --input-right=FILE

    The right input file for FASTQ paired end reads.

     --output=DIRSpecifies the directory where results are reported.

    --output=DIR

    Specifies the directory where results are reported.

     --platformSpecifies the platform of the input data. (Must be one of [illumina, iontorrent]) (Default is illumina).

    --platform

    Specifies the platform of the input data. (Must be one of [illumina, iontorrent]) (Default is illumina).

     --species=SDFSpecifies the SDF containing species reference sequences.

    --species=SDF

    Specifies the SDF containing species reference sequences.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -6755,8 +6608,8 @@

    composition-meta-pipelinehttp://www.realtimegenomics.com).

    -

    See also

    -

    mapf, +

    See also

    +

    mapf, map, species, composition-functional-meta-pipeline

    @@ -6783,61 +6636,61 @@

    functional-meta-pipeline +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --filter=SDFSpecifies the SDF containing the filter reference sequences.

    --filter=SDF

    Specifies the SDF containing the filter reference sequences.

     --input=SDF|FILESpecifies the path to the reads to be processed.

    --input=SDF|FILE

    Specifies the path to the reads to be processed.

     --input-left=FILEThe left input file for FASTQ paired end reads.

    --input-left=FILE

    The left input file for FASTQ paired end reads.

     --input-right=FILEThe right input file for FASTQ paired end reads.

    --input-right=FILE

    The right input file for FASTQ paired end reads.

     --output=DIRSpecifies the directory where results are reported.

    --output=DIR

    Specifies the directory where results are reported.

     --platformSpecifies the platform of the input data. Allowed values are [illumina, iontorrent] (Default is illumina)

    --platform

    Specifies the platform of the input data. Allowed values are [illumina, iontorrent] (Default is illumina)

     --protein=SDFSpecifies the SDF containing protein reference sequences.

    --protein=SDF

    Specifies the SDF containing protein reference sequences.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -6882,8 +6735,8 @@

    functional-meta-pipelinehttp://www.realtimegenomics.com).

    @@ -6911,65 +6764,65 @@

    composition-functional-meta-pipeline +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --filter=SDFSpecifies the SDF containing the filter reference sequences.

    --filter=SDF

    Specifies the SDF containing the filter reference sequences.

     --input=SDF|FILESpecifies the path to the reads to be processed.

    --input=SDF|FILE

    Specifies the path to the reads to be processed.

     --input-left=FILEThe left input file for FASTQ paired end reads.

    --input-left=FILE

    The left input file for FASTQ paired end reads.

     --input-right=FILEThe right input file for FASTQ paired end reads.

    --input-right=FILE

    The right input file for FASTQ paired end reads.

     --output=DIRSpecifies the directory where results are reported.

    --output=DIR

    Specifies the directory where results are reported.

     --platformSpecifies the platform of the input data. Allowed values are [illumina, iontorrent] (Default is illumina).

    --platform

    Specifies the platform of the input data. Allowed values are [illumina, iontorrent] (Default is illumina).

     --species=SDFSpecifies the SDF containing species reference sequences.

    --species=SDF

    Specifies the SDF containing species reference sequences.

     --protein=SDFSpecifies the SDF containing protein reference sequences.

    --protein=SDF

    Specifies the SDF containing protein reference sequences.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -7026,8 +6879,8 @@

    composition-functional-meta-pipelinehttp://www.realtimegenomics.com).

    -

    See also

    -

    mapf, +

    See also

    +

    mapf, mapx, map, species

    @@ -7072,70 +6925,70 @@

    genomesim +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

    -o--output=SDFThe name of the output SDF.

    -o

    --output=SDF

    The name of the output SDF.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --comment=STRINGSpecify a comment to include in the generated SDF.

    --comment=STRING

    Specify a comment to include in the generated SDF.

     --freq=STRINGSet the relative frequencies of A,C,G,T in the generated sequence. (Default is 1,1,1,1).

    --freq=STRING

    Set the relative frequencies of A,C,G,T in the generated sequence. (Default is 1,1,1,1).

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -l--length=INTSpecify the length of generated sequence. May be specified 0 or more times, or as a comma separated list.

    -l

    --length=INT

    Specify the length of generated sequence. May be specified 0 or more times, or as a comma separated list.

     --max-length=INTSpecify the maximum sequence length.

    --max-length=INT

    Specify the maximum sequence length.

     --min-length=INTSpecify the minimum sequence length.

    --min-length=INT

    Specify the minimum sequence length.

    -n--num-contigs=INTSpecify the number of sequences to generate.

    -n

    --num-contigs=INT

    Specify the number of sequences to generate.

     --prefix=STRINGSpecify a sequence name prefix to be used for the generated sequences. The default is to name the output sequences -‘simulatedSequenceN’, where N is increasing for each sequence.

    --prefix=STRING

    Specify a sequence name prefix to be used for the generated sequences. The default is to name the output sequences +‘simulatedSequenceN’, where N is increasing for each sequence.

    -s--seed=INTSpecify seed for the random number generator.

    -s

    --seed=INT

    Specify seed for the random number generator.

    @@ -7151,8 +7004,8 @@

    genomesim--prefix=chr --num-contigs=10 would yield contigs named chr1 through chr10.

    -

    See also

    -

    cgsim, +

    See also

    +

    cgsim, readsim, popsim, samplesim

    @@ -7176,135 +7029,135 @@

    cgsim

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -t--input=SDFSDF containing input genome.

    -t

    --input=SDF

    SDF containing input genome.

    -o--output=SDFName for reads output SDF.

    -o

    --output=SDF

    Name for reads output SDF.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Fragment Generation

    Fragment Generation

     --abundanceIf set, the user-supplied distribution represents desired abundance.

    --abundance

    If set, the user-supplied distribution represents desired abundance.

    -N--allow-unknownsAllow reads to be drawn from template fragments containing unknown nucleotides.

    -N

    --allow-unknowns

    Allow reads to be drawn from template fragments containing unknown nucleotides.

    -c--coverage=FLOATCoverage, must be positive.

    -c

    --coverage=FLOAT

    Coverage, must be positive.

    -D--distribution=FILEFile containing probability distribution for sequence selection.

    -D

    --distribution=FILE

    File containing probability distribution for sequence selection.

     --dna-fractionIf set, the user-supplied distribution represents desired DNA fraction.

    --dna-fraction

    If set, the user-supplied distribution represents desired DNA fraction.

    -M--max-fragment-size=INTMaximum fragment size (Default is 500)

    -M

    --max-fragment-size=INT

    Maximum fragment size (Default is 500)

    -m--min-fragment-size=INTMinimum fragment size (Default is 350)

    -m

    --min-fragment-size=INT

    Minimum fragment size (Default is 350)

     --n-rate=FLOATRate that the machine will generate new unknowns in the read (Default is 0.0)

    --n-rate=FLOAT

    Rate that the machine will generate new unknowns in the read (Default is 0.0)

    -n--num-reads=INTNumber of reads to be generated.

    -n

    --num-reads=INT

    Number of reads to be generated.

     --taxonomy-distribution=FILEFile containing probability distribution for sequence selection expressed by taxonomy id.

    --taxonomy-distribution=FILE

    File containing probability distribution for sequence selection expressed by taxonomy id.

    - +
    ---+++ - - + + - - - - + + + +
    Complete Genomics

    Complete Genomics

    -V--cg-read-version=INTSelect Complete Genomics read structure version, 1 (35 bp) or 2 (29 bp)

    -V

    --cg-read-version=INT

    Select Complete Genomics read structure version, 1 (35 bp) or 2 (29 bp)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --comment=STRINGComment to include in the generated SDF.

    --comment=STRING

    Comment to include in the generated SDF.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-namesDo not create read names in the output SDF.

    --no-names

    Do not create read names in the output SDF.

     --no-qualitiesDo not create read qualities in the output SDF.

    --no-qualities

    Do not create read qualities in the output SDF.

    -q--qual-range=STRINGSet the range of base quality values permitted e.g.: 3-40 (Default is fixed qualities corresponding to overall machine base error rate)

    -q

    --qual-range=STRING

    Set the range of base quality values permitted e.g.: 3-40 (Default is fixed qualities corresponding to overall machine base error rate)

     --sam-rg=STRING|FILEFile containing a single valid read group SAM header line or a string in the form @RG\tID:READGROUP1\tSM:BACT_SAMPLE\tPL:ILLUMINA

    --sam-rg=STRING|FILE

    File containing a single valid read group SAM header line or a string in the form @RG\tID:READGROUP1\tSM:BACT_SAMPLE\tPL:ILLUMINA

    -s--seed=INTSeed for random number generator.

    -s

    --seed=INT

    Seed for random number generator.

    @@ -7322,8 +7175,8 @@

    cgsim metagenomic databases. Probabilities are numbers between zero and one and must sum to one in the file.

    -

    See also

    -

    genomesim, +

    See also

    +

    genomesim, readsim, popsim, samplesim

    @@ -7349,202 +7202,202 @@

    readsim +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -t--input=SDFSDF containing input genome.

    -t

    --input=SDF

    SDF containing input genome.

     --machine=STRINGSelect the sequencing technology to model. Allowed values are [illumina_se, illumina_pe, complete_genomics, complete_genomics_2, 454_pe, 454_se, iontorrent]

    --machine=STRING

    Select the sequencing technology to model. Allowed values are [illumina_se, illumina_pe, complete_genomics, complete_genomics_2, 454_pe, 454_se, iontorrent]

    -o--output=SDFName for reads output SDF.

    -o

    --output=SDF

    Name for reads output SDF.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Fragment Generation

    Fragment Generation

     --abundanceIf set, the user-supplied distribution represents desired abundance.

    --abundance

    If set, the user-supplied distribution represents desired abundance.

    -N--allow-unknownsAllow reads to be drawn from template fragments containing unknown nucleotides.

    -N

    --allow-unknowns

    Allow reads to be drawn from template fragments containing unknown nucleotides.

    -c--coverage=FLOATCoverage, must be positive.

    -c

    --coverage=FLOAT

    Coverage, must be positive.

    -D--distribution=FILEFile containing probability distribution for sequence selection.

    -D

    --distribution=FILE

    File containing probability distribution for sequence selection.

     --dna-fractionIf set, the user-supplied distribution represents desired DNA fraction.

    --dna-fraction

    If set, the user-supplied distribution represents desired DNA fraction.

    -M--max-fragment-size=INTMaximum fragment size (Default is 250)

    -M

    --max-fragment-size=INT

    Maximum fragment size (Default is 250)

    -m--min-fragment-size=INTMinimum fragment size (Default is 200)

    -m

    --min-fragment-size=INT

    Minimum fragment size (Default is 200)

     --n-rate=FLOATRate that the machine will generate new unknowns in the read (Default is 0.0)

    --n-rate=FLOAT

    Rate that the machine will generate new unknowns in the read (Default is 0.0)

    -n--num-reads=INTNumber of reads to be generated.

    -n

    --num-reads=INT

    Number of reads to be generated.

     --taxonomy-distribution=FILEFile containing probability distribution for sequence selection expressed by taxonomy id.

    --taxonomy-distribution=FILE

    File containing probability distribution for sequence selection expressed by taxonomy id.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Illumina PE

    Illumina PE

    -L--left-read-length=INTTarget read length on the left side.

    -L

    --left-read-length=INT

    Target read length on the left side.

    -R--right-read-length=INTTarget read length on the right side.

    -R

    --right-read-length=INT

    Target read length on the right side.

    - +
    ---+++ - - + + - - - - + + + +
    Illumina SE

    Illumina SE

    -r--read-length=INTTarget read length, must be positive.

    -r

    --read-length=INT

    Target read length, must be positive.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    454 SE/PE

    454 SE/PE

     --454-max-total-size=INTMaximum 454 read length (in paired end case the sum of the left and the right read lengths)

    --454-max-total-size=INT

    Maximum 454 read length (in paired end case the sum of the left and the right read lengths)

     --454-min-total-size=INTMinimum 454 read length (in paired end case the sum of the left and the right read lengths)

    --454-min-total-size=INT

    Minimum 454 read length (in paired end case the sum of the left and the right read lengths)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    IonTorrent SE

    IonTorrent SE

     --ion-max-total-size=INTMaximum IonTorrent read length.

    --ion-max-total-size=INT

    Maximum IonTorrent read length.

     --ion-min-total-size=INTMinimum IonTorrent read length.

    --ion-min-total-size=INT

    Minimum IonTorrent read length.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --comment=STRINGComment to include in the generated SDF.

    --comment=STRING

    Comment to include in the generated SDF.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --no-namesDo not create read names in the output SDF.

    --no-names

    Do not create read names in the output SDF.

     --no-qualitiesDo not create read qualities in the output SDF.

    --no-qualities

    Do not create read qualities in the output SDF.

    -q--qual-range=STRINGSet the range of base quality values permitted e.g.: 3-40 (Default is fixed qualities corresponding to overall machine base error rate)

    -q

    --qual-range=STRING

    Set the range of base quality values permitted e.g.: 3-40 (Default is fixed qualities corresponding to overall machine base error rate)

     --sam-rg=STRING|FILEFile containing a single valid read group SAM header line or a string in the form @RG\tID:READGROUP1\tSM:BACT_SAMPLE\tPL:ILLUMINA

    --sam-rg=STRING|FILE

    File containing a single valid read group SAM header line or a string in the form @RG\tID:READGROUP1\tSM:BACT_SAMPLE\tPL:ILLUMINA

    -s--seed=INTSeed for random number generator.

    -s

    --seed=INT

    Seed for random number generator.

    @@ -7588,8 +7441,8 @@

    readsim -

    See also

    -

    cgsim, +

    See also

    +

    cgsim, genomesim, popsim, samplesim

    @@ -7609,123 +7462,123 @@

    readsimeval +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -M--mutations-vcf=FILEVCF file containing genomic mutations to be compensated for.

    -M

    --mutations-vcf=FILE

    VCF file containing genomic mutations to be compensated for.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

    -r--reads=SDFSDF containing reads.

    -r

    --reads=SDF

    SDF containing reads.

    -S--sample=STRINGName of the sample to use from the mutation VCF file, will default to using the first sample in the file.

    -S

    --sample=STRING

    Name of the sample to use from the mutation VCF file, will default to using the first sample in the file.

     FILE+SAM/BAM format files. Must be specified 1 or more times.

    FILE+

    SAM/BAM format files. Must be specified 1 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --exclude-duplicatesExclude all SAM records flagged as a PCR or optical duplicate.

    --exclude-duplicates

    Exclude all SAM records flagged as a PCR or optical duplicate.

     --exclude-matedExclude all mated SAM records.

    --exclude-mated

    Exclude all mated SAM records.

     --exclude-unmatedExclude all unmated SAM records.

    --exclude-unmated

    Exclude all unmated SAM records.

     --max-as-mated=INTIf set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    --max-as-mated=INT

    If set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

     --max-as-unmated=INTIf set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    --max-as-unmated=INT

    If set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

    -v--variance=INTVariation allowed in start position (Default is 0).

    -v

    --variance=INT

    Variation allowed in start position (Default is 0).

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --mapq-histogramOutput histogram of MAPQ scores.

    --mapq-histogram

    Output histogram of MAPQ scores.

     --mapq-rocOutput ROC table with respect to MAPQ scores.

    --mapq-roc

    Output ROC table with respect to MAPQ scores.

     --score-histogramOutput histogram of read alignment / generated scores.

    --score-histogram

    Output histogram of read alignment / generated scores.

     --verboseProvide more detailed breakdown of stats.

    --verbose

    Provide more detailed breakdown of stats.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -7734,8 +7587,8 @@

    readsimevalreadsim command. The ROC output files may be plotted with the rocplot command.

    @@ -7756,49 +7609,49 @@

    popsim +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -o--output=FILEOutput VCF file name.

    -o

    --output=FILE

    Output VCF file name.

    -t--reference=SDFSDF containing the reference genome.

    -t

    --reference=SDF

    SDF containing the reference genome.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --seed=INTSeed for the random number generator.

    --seed=INT

    Seed for the random number generator.

    @@ -7810,8 +7663,8 @@

    popsim -

    See also

    -

    readsim, +

    See also

    +

    readsim, genomesim, samplesim, childsim, @@ -7838,73 +7691,73 @@

    samplesim +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILEInput VCF containing population variants.

    -i

    --input=FILE

    Input VCF containing population variants.

    -o--output=FILEOutput VCF file name.

    -o

    --output=FILE

    Output VCF file name.

     --output-sdf=SDFIf set, output an SDF containing the sample genome.

    --output-sdf=SDF

    If set, output an SDF containing the sample genome.

    -t--reference=SDFSDF containing the reference genome.

    -t

    --reference=SDF

    SDF containing the reference genome.

    -s--sample=STRINGName for sample.

    -s

    --sample=STRING

    Name for sample.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --allow-missing-afIf set, treat variants without allele frequency annotation as uniformly likely.

    --allow-missing-af

    If set, treat variants without allele frequency annotation as uniformly likely.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --ploidy=STRINGPloidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

    --ploidy=STRING

    Ploidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

     --seed=INTSeed for the random number generator.

    --seed=INT

    Seed for the random number generator.

     --sex=SEXSex of individual. Allowed values are [male, female, either] (Default is either)

    --sex=SEX

    Sex of individual. Allowed values are [male, female, either] (Default is either)

    @@ -7932,8 +7785,8 @@

    samplesimreadsim command to simulate a read set for the individual.

    -

    See also

    -

    readsim, +

    See also

    +

    readsim, genomesim, popsim, childsim, @@ -7955,77 +7808,77 @@

    denovosim +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILEThe input VCF containing parent variants.

    -i

    --input=FILE

    The input VCF containing parent variants.

     --original=STRINGThe name of the existing sample to use as the original genotype.

    --original=STRING

    The name of the existing sample to use as the original genotype.

    -o--output=FILEThe output VCF file name.

    -o

    --output=FILE

    The output VCF file name.

     --output-sdf=FILESet to output an SDF of the genome generated.

    --output-sdf=FILE

    Set to output an SDF of the genome generated.

    -t--reference=SDFThe SDF containing the reference genome.

    -t

    --reference=SDF

    The SDF containing the reference genome.

    -s--sample=STRINGThe name for the new derived sample.

    -s

    --sample=STRING

    The name for the new derived sample.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -Z--no-gzipSet this flag to create the VCF output file without compression.

    -Z

    --no-gzip

    Set this flag to create the VCF output file without compression.

     --num-mutations=INTSet the expected number of de novo mutations per genome (Default is 70).

    --num-mutations=INT

    Set the expected number of de novo mutations per genome (Default is 70).

     --ploidy=STRINGThe ploidy to use when the reference genome does not contain a reference text file. Allowed values are [auto, diploid, haploid] (Default is auto)

    --ploidy=STRING

    The ploidy to use when the reference genome does not contain a reference text file. Allowed values are [auto, diploid, haploid] (Default is auto)

     --seed=INTSet the seed for the random number generator.

    --seed=INT

    Set the seed for the random number generator.

     --show-mutationsSet this flag to display information regarding de novo mutation points.

    --show-mutations

    Set this flag to display information regarding de novo mutation points.

    @@ -8052,8 +7905,8 @@

    denovosimreadsim command to simulate a read set for the new genome.

    -

    See also

    -

    readsim, +

    See also

    +

    readsim, genomesim, popsim, samplesim, @@ -8076,89 +7929,89 @@

    childsim +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --father=STRINGName of the existing sample to use as the father.

    --father=STRING

    Name of the existing sample to use as the father.

    -i--input=FILEInput VCF containing parent variants.

    -i

    --input=FILE

    Input VCF containing parent variants.

     --mother=STRINGName of the existing sample to use as the mother.

    --mother=STRING

    Name of the existing sample to use as the mother.

    -o--output=FILEOutput VCF file name.

    -o

    --output=FILE

    Output VCF file name.

     --output-sdf=SDFIf set, output an SDF containing the sample genome.

    --output-sdf=SDF

    If set, output an SDF containing the sample genome.

    -t--reference=SDFSDF containing the reference genome.

    -t

    --reference=SDF

    SDF containing the reference genome.

    -s--sample=STRINGName for new child sample.

    -s

    --sample=STRING

    Name for new child sample.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --extra-crossovers=FLOATProbability of extra crossovers per chromosome (Default is 0.01)

    --extra-crossovers=FLOAT

    Probability of extra crossovers per chromosome (Default is 0.01)

     --genetic-map-dir=DIRIf set, load genetic maps from this directory for recombination point selection.

    --genetic-map-dir=DIR

    If set, load genetic maps from this directory for recombination point selection.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --ploidy=STRINGPloidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

    --ploidy=STRING

    Ploidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

     --seed=INTSeed for the random number generator.

    --seed=INT

    Seed for the random number generator.

     --sex=SEXSex of individual. Allowed values are [male, female, either] (Default is either)

    --sex=SEX

    Sex of individual. Allowed values are [male, female, either] (Default is either)

     --show-crossoversIf set, display information regarding haplotype selection and crossover points.

    --show-crossovers

    If set, display information regarding haplotype selection and crossover points.

    @@ -8184,8 +8037,8 @@

    childsimGenetic map directory, and the directory containing the relevant files can be specified by using the --genetic-map-dir flag.

    -

    See also

    -

    readsim, +

    See also

    +

    readsim, genomesim, popsim, samplesim, @@ -8208,81 +8061,81 @@

    pedsamplesim +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILEInput VCF containing parent variants.

    -i

    --input=FILE

    Input VCF containing parent variants.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --output-sdfIf set, output an SDF for the genome of each simulated sample.

    --output-sdf

    If set, output an SDF for the genome of each simulated sample.

    -p--pedigree=FILEGenome relationships PED file.

    -p

    --pedigree=FILE

    Genome relationships PED file.

    -t--reference=SDFSDF containing the reference genome.

    -t

    --reference=SDF

    SDF containing the reference genome.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --extra-crossovers=FLOATProbability of extra crossovers per chromosome (Default is 0.01)

    --extra-crossovers=FLOAT

    Probability of extra crossovers per chromosome (Default is 0.01)

     --genetic-map-dir=DIRIf set, load genetic maps from this directory for recombination point selection.

    --genetic-map-dir=DIR

    If set, load genetic maps from this directory for recombination point selection.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --num-mutations=INTExpected number of mutations per genome (Default is 70)

    --num-mutations=INT

    Expected number of mutations per genome (Default is 70)

     --ploidy=STRINGPloidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

    --ploidy=STRING

    Ploidy to use. Allowed values are [auto, diploid, haploid] (Default is auto)

     --remove-unusedIf set, output only variants used by at least one sample.

    --remove-unused

    If set, output only variants used by at least one sample.

     --seed=INTSeed for the random number generator.

    --seed=INT

    Seed for the random number generator.

    @@ -8324,8 +8177,8 @@

    pedsamplesimGenetic map directory, and the directory containing the relevant files can be specified by using the --genetic-map-dir flag.

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -l--compression-level=INTThe compression level to use, between 1 (least but fast) and 9 (highest but slow) (Default is 5)

    -l

    --compression-level=INT

    The compression level to use, between 1 (least but fast) and 9 (highest but slow) (Default is 5)

    -d--decompressDecompress.

    -d

    --decompress

    Decompress.

    -f--forceForce overwrite of output file.

    -f

    --force

    Force overwrite of output file.

     --no-terminateIf set, do not add the block gzip termination block.

    --no-terminate

    If set, do not add the block gzip termination block.

    -c--stdoutWrite on standard output, keep original files unchanged. Implied when using standard input.

    -c

    --stdout

    Write on standard output, keep original files unchanged. Implied when using standard input.

     FILE+File to (de)compress, use ‘-‘ for standard input. Must be specified 1 or more times.

    FILE+

    File to (de)compress, use ‘-‘ for standard input. Must be specified 1 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -8489,8 +8342,8 @@

    bgzip SAM, TSV must be block-compressed before they can be indexed for fast retrieval of records corresponding to specific genomic regions.

    @@ -8512,45 +8365,45 @@

    index

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -f--format=FORMATFormat of input to index. Allowed values are [sam, bam, cram, sv, coveragetsv, bed, vcf, auto] (Default is auto)

    -f

    --format=FORMAT

    Format of input to index. Allowed values are [sam, bam, cram, sv, coveragetsv, bed, vcf, auto] (Default is auto)

    -I--input-list-file=FILEFile containing a list of block compressed files (1 per line) containing genome position data.

    -I

    --input-list-file=FILE

    File containing a list of block compressed files (1 per line) containing genome position data.

     FILE+Block compressed files containing data to be indexed. May be specified 0 or more times.

    FILE+

    Block compressed files containing data to be indexed. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -8560,8 +8413,8 @@

    index TSV output from RTG commands such as coverage. The index command can also be used to produce BAM indexes for BAM files with no index.

    Parameters:

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -b--baseline=FILEVCF file containing baseline variants.

    -b

    --baseline=FILE

    VCF file containing baseline variants.

    -B--bed=FILEBED file containing regions to overlay. May be specified 0 or more times.

    -B

    --bed=FILE

    BED file containing regions to overlay. May be specified 0 or more times.

    -c--calls=FILEVCF file containing called variants. May be specified 0 or more times.

    -c

    --calls=FILE

    VCF file containing called variants. May be specified 0 or more times.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line)

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line)

    -r--reads=SDFRead SDF (only needed to indicate correctness of simulated read mappings). May be specified 0 or more times.

    -r

    --reads=SDF

    Read SDF (only needed to indicate correctness of simulated read mappings). May be specified 0 or more times.

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+Alignment SAM/BAM files. May be specified 0 or more times.

    FILE+

    Alignment SAM/BAM files. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Filtering

    Filtering

    -p--padding=INTPadding around region of interest (Default is to automatically determine padding to avoid read truncation)

    -p

    --padding=INT

    Padding around region of interest (Default is to automatically determine padding to avoid read truncation)

     --region=REGIONThe region of interest to display. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    The region of interest to display. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

     --sample=STRINGSpecify name of sample to select. May be specified 0 or more times, or as a comma separated list.

    --sample=STRING

    Specify name of sample to select. May be specified 0 or more times, or as a comma separated list.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --htmlOutput as HTML.

    --html

    Output as HTML.

     --no-base-colorsDo not use base-colors.

    --no-base-colors

    Do not use base-colors.

     --no-colorDo not use colors.

    --no-color

    Do not use colors.

     --no-dotsDisplay nucleotide instead of dots.

    --no-dots

    Display nucleotide instead of dots.

     --print-cigarsPrint alignment cigars.

    --print-cigars

    Print alignment cigars.

     --print-mapqPrint alignment MAPQ values.

    --print-mapq

    Print alignment MAPQ values.

     --print-mate-positionPrint mate position.

    --print-mate-position

    Print mate position.

     --print-namesPrint read names.

    --print-names

    Print read names.

     --print-readgroupPrint read group id for each alignment.

    --print-readgroup

    Print read group id for each alignment.

     --print-reference-line=INTPrint reference line every N lines (Default is 0)

    --print-reference-line=INT

    Print reference line every N lines (Default is 0)

     --print-samplePrint sample id for each alignment.

    --print-sample

    Print sample id for each alignment.

     --print-soft-clipped-basesPrint soft clipped bases.

    --print-soft-clipped-bases

    Print soft clipped bases.

     --project-track=INTIf set, project highlighting for the specified track down through reads (Default projects the union of tracks)

    --project-track=INT

    If set, project highlighting for the specified track down through reads (Default projects the union of tracks)

     --sort-readgroupSort reads first on read group and then on start position.

    --sort-readgroup

    Sort reads first on read group and then on start position.

     --sort-readsSort reads on start position.

    --sort-reads

    Sort reads on start position.

     --sort-sampleSort reads first on sample id and then on start position.

    --sort-sample

    Sort reads first on sample id and then on start position.

     --unflattenDisplay unflattened CGI reads when present.

    --unflatten

    Display unflattened CGI reads when present.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -8862,8 +8715,8 @@

    aview displays for multiple regions for later viewing (either as text or HTML).

    -

    See also

    -

    map, +

    See also

    +

    map, snp

    @@ -8898,74 +8751,74 @@

    sdfstats +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

     SDF+Specifies an SDF on which statistics are to be reported. May be specified 1 or more times.

    SDF+

    Specifies an SDF on which statistics are to be reported. May be specified 1 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --lengthsSet to print out the name and length of each sequence. (Not recommended for read sets).

    --lengths

    Set to print out the name and length of each sequence. (Not recommended for read sets).

    -p--positionSet to include information about unknown bases (Ns) by read position.

    -p

    --position

    Set to include information about unknown bases (Ns) by read position.

    -q--qualitySet to display mean of quality.

    -q

    --quality

    Set to display mean of quality.

     --sex=SEXSet to display the reference sequence list for the given sex. Allowed values are [male, female, either]. May be specified 0 or more times, or as a comma separated list.

    --sex=SEX

    Set to display the reference sequence list for the given sex. Allowed values are [male, female, either]. May be specified 0 or more times, or as a comma separated list.

     --taxonomySet to display information about the taxonomy.

    --taxonomy

    Set to display information about the taxonomy.

    -n--unknownsSet to include information about unknown bases (Ns).

    -n

    --unknowns

    Set to include information about unknown bases (Ns).

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -8973,8 +8826,8 @@

    sdfstatssdfstats command to get information about the contents of SDFs.

    -

    See also

    -

    format, +

    See also

    +

    format, cg2sdf, sdf2fasta, sdf2fastq, @@ -9002,57 +8855,57 @@

    sdfsplit +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILESpecifies a file containing a list of input SDFs (one per line).

    -I

    --input-list-file=FILE

    Specifies a file containing a list of input SDFs (one per line).

    -o--output=DIRSpecifies the directory that will contain the split output bases (must be empty if present).

    -o

    --output=DIR

    Specifies the directory that will contain the split output bases (must be empty if present).

     SDF+Specifies an input SDF. May be specified 0 or more times.

    SDF+

    Specifies an input SDF. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

     --allow-duplicate-namesSet to disable duplicate name detection. Use this if you need to use less memory and you are certain there are no duplicate names in the input.

    --allow-duplicate-names

    Set to disable duplicate name detection. Use this if you need to use less memory and you are certain there are no duplicate names in the input.

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

     --in-memoryProcess in memory instead of from disk. (Faster but requires more RAM).

    --in-memory

    Process in memory instead of from disk. (Faster but requires more RAM).

    -n--num-sequencesSpecifies the number of sequences allowed in each SDF. Generally, this command is used to split up read data sets of considerable size.

    -n

    --num-sequences

    Specifies the number of sequences allowed in each SDF. Generally, this command is used to split up read data sets of considerable size.

    @@ -9078,8 +8931,8 @@

    sdfsplit--end-read flag options that may be preferable to using sdfsplit in most situations.

    -

    See also

    -

    format, +

    See also

    +

    format, cg2sdf, sdf2fasta, sdfstats, @@ -9105,74 +8958,74 @@

    sdfsubset +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=SDFSpecifies the input SDF.

    -i

    --input=SDF

    Specifies the input SDF.

    -o--output=SDFThe name of the output SDF.

    -o

    --output=SDF

    The name of the output SDF.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --end-id=INTOnly output sequences with sequence id less than the given number. (Sequence ids start at 0).

    --end-id=INT

    Only output sequences with sequence id less than the given number. (Sequence ids start at 0).

     --start-id=INTOnly output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    --start-id=INT

    Only output sequences with sequence id greater than or equal to the given number. (Sequence ids start at 0).

    -I--id-file=FILEName of a file containing a list of sequences to extract, one per line.

    -I

    --id-file=FILE

    Name of a file containing a list of sequences to extract, one per line.

     --namesInterpret any specified sequence as names instead of numeric sequence ids.

    --names

    Interpret any specified sequence as names instead of numeric sequence ids.

     STRING+Specifies the sequence id, or sequence name if the names flag is set to extract from the input SDF. May be specified 0 or more times.

    STRING+

    Specifies the sequence id, or sequence name if the names flag is set to extract from the input SDF. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -9190,8 +9043,8 @@

    sdfsubset -

    See also

    -

    sdfsubseq, +

    See also

    +

    sdfsubseq, sdfstats

    @@ -9213,71 +9066,71 @@

    sdfsubseq +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

    -i--input=FILESpecifies the input SDF.

    -i

    --input=FILE

    Specifies the input SDF.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Filtering

    Filtering

    -I--sequence-idIf set, use sequence id instead of sequence name in region (0-based)

    -I

    --sequence-id

    If set, use sequence id instead of sequence name in region (0-based)

     REGION+The range to display. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or <sequence_name>:<pos>~<padding>. -Must be specified 1 or more times.

    REGION+

    The range to display. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or <sequence_name>:<pos>~<padding>. +Must be specified 1 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -f--fastaSet to output in FASTA format.

    -f

    --fasta

    Set to output in FASTA format.

    -q--fastqSet to output in FASTQ format.

    -q

    --fastq

    Set to output in FASTQ format.

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -r--reverse-complementSet to output in reverse complement.

    -r

    --reverse-complement

    Set to output in reverse complement.

    @@ -9290,8 +9143,8 @@

    sdfsubseq -

    See also

    -

    sdfsubset, +

    See also

    +

    sdfsubset, sdfstats

    @@ -9309,41 +9162,41 @@

    sam2bam +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -o--output=FILEName for output BAM file.

    -o

    --output=FILE

    Name for output BAM file.

     FILE+SAM/BAM format files containing mapped reads. Must be specified 1 or more times.

    FILE+

    SAM/BAM format files containing mapped reads. Must be specified 1 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -9354,8 +9207,8 @@

    sam2bamsammerge.

    @@ -9379,155 +9232,155 @@

    sammerge +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read SAM records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read SAM records that overlap the ranges contained in the specified BED file.

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -o--output=FILEName for output SAM/BAM file. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Name for output SAM/BAM file. Use ‘-‘ to write to standard output.

     --region=REGIONIf set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> -or <sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only process SAM records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> +or <sequence_name>:<pos>~<padding>

    -t--template=SDFSDF containing the reference genome to use when decoding CRAM input.

    -t

    --template=SDF

    SDF containing the reference genome to use when decoding CRAM input.

     FILE+SAM/BAM format files containing coordinate-sorted reads. May be specified 0 or more times.

    FILE+

    SAM/BAM format files containing coordinate-sorted reads. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --exclude-duplicatesExclude all SAM records flagged as a PCR or optical duplicate.

    --exclude-duplicates

    Exclude all SAM records flagged as a PCR or optical duplicate.

     --exclude-matedExclude all mated SAM records.

    --exclude-mated

    Exclude all mated SAM records.

     --exclude-unmappedExclude all unmapped SAM records.

    --exclude-unmapped

    Exclude all unmapped SAM records.

     --exclude-unmatedExclude all unmated SAM records.

    --exclude-unmated

    Exclude all unmated SAM records.

     --exclude-unplacedExclude all SAM records with no alignment position.

    --exclude-unplaced

    Exclude all SAM records with no alignment position.

    -F--filter-flags=INTDecimal mask indicating SAM FLAG bits that must not be set for the record.

    -F

    --filter-flags=INT

    Decimal mask indicating SAM FLAG bits that must not be set for the record.

     --invertIf set, invert the result of flag and attribute based filter criteria.

    --invert

    If set, invert the result of flag and attribute based filter criteria.

    -m--max-as-mated=INTIf set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -m

    --max-as-mated=INT

    If set, ignore mated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u--max-as-unmated=INTIf set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -u

    --max-as-unmated=INT

    If set, ignore unmated SAM records with an alignment score (AS attribute) that exceeds this value.

    -c--max-hits=INTIf set, ignore SAM records with an alignment count that exceeds this value.

    -c

    --max-hits=INT

    If set, ignore SAM records with an alignment count that exceeds this value.

     --min-mapq=INTIf set, ignore SAM records with MAPQ less than this value.

    --min-mapq=INT

    If set, ignore SAM records with MAPQ less than this value.

     --min-read-length=INTIf set, ignore SAM reads with read length less than this value.

    --min-read-length=INT

    If set, ignore SAM reads with read length less than this value.

     --remove-duplicatesDetect and remove duplicate reads based on mapping position.

    --remove-duplicates

    Detect and remove duplicate reads based on mapping position.

    -f--require-flags=INTDecimal mask indicating SAM FLAG bits that must be set for the record.

    -f

    --require-flags=INT

    Decimal mask indicating SAM FLAG bits that must be set for the record.

    -r--select-read-group=STRINGSelect only SAM records with this read group ID. May be specified 0 or more times, or as a comma separated list.

    -r

    --select-read-group=STRING

    Select only SAM records with this read group ID. May be specified 0 or more times, or as a comma separated list.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --legacy-cigarsIf set, produce legacy cigars (using M rather than X or =) in output.

    --legacy-cigars

    If set, produce legacy cigars (using M rather than X or =) in output.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-headerPrevent SAM/BAM header from being written.

    --no-header

    Prevent SAM/BAM header from being written.

     --seed=INTSeed used during subsampling.

    --seed=INT

    Seed used during subsampling.

     --subsample=FLOATIf set, subsample the input to retain this fraction of reads.

    --subsample=FLOAT

    If set, subsample the input to retain this fraction of reads.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -9545,8 +9398,8 @@

    sammergecalibrate separately on the newly created BAM file.

    @@ -9564,78 +9417,78 @@

    samstats +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILESpecifies a file containing a list of SAM/BAM format files (one per line) containing mapped reads.

    -I

    --input-list-file=FILE

    Specifies a file containing a list of SAM/BAM format files (one per line) containing mapped reads.

    -r--reads=SDFSpecifies the SDF containing the reads.

    -r

    --reads=SDF

    Specifies the SDF containing the reads.

    -t--template=SDFSpecifies the reference genome SDF.

    -t

    --template=SDF

    Specifies the reference genome SDF.

     FILE+Specifies a SAM/BAM result file (must contain read-ids not read names). May be specified 0 or more times.

    FILE+

    Specifies a SAM/BAM result file (must contain read-ids not read names). May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --consensusSet to record consensus data. Requires roughly 5 fold reference genome length of RAM.

    --consensus

    Set to record consensus data. Requires roughly 5 fold reference genome length of RAM.

    -D--distributionsSet to display distributions of insert sizes, alignment scores and read hits.

    -D

    --distributions

    Set to display distributions of insert sizes, alignment scores and read hits.

     --per-fileSet to output per-file statistics as well as the summary of all SAM/BAM files.

    --per-file

    Set to output per-file statistics as well as the summary of all SAM/BAM files.

     --validateSet to validate mapping of read to reference. Tests matching of bases according to CIGAR format.

    --validate

    Set to validate mapping of read to reference. Tests matching of bases according to CIGAR format.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -9666,8 +9519,8 @@

    samstats--validate flag to force the reporting of problems in the alignments file.

    @@ -9781,45 +9634,45 @@

    mapxrename +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=SDFSDF for the reads in the mapx file.

    -i

    --input=SDF

    SDF for the reads in the mapx file.

    -o--output=FILERenamed output mapx file.

    -o

    --output=FILE

    Renamed output mapx file.

     FILEInput mapx file.

    FILE

    Input mapx file.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -9832,8 +9685,8 @@

    mapxrename_rename to the file name. For example, alignments.tsv.gz becomes alignments_rename.tsv.gz.

    @@ -9867,82 +9720,82 @@

    chrstats +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -I--input-list-file=FILEFile containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -I

    --input-list-file=FILE

    File containing a list of SAM/BAM format files (1 per line) containing mapped reads.

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

     FILE+alignment files to process. Must be specified 1 or more times

    FILE+

    alignment files to process. Must be specified 1 or more times

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --output-pedigree=FILEoutput best guest of per-sample sex information to PED file

    --output-pedigree=FILE

    output best guest of per-sample sex information to PED file

    -s--sample=STRINGthe name of the sample to check (required when checking single sample from multiple samples alignments)

    -s

    --sample=STRING

    the name of the sample to check (required when checking single sample from multiple samples alignments)

     --sex=SEXsex setting that the individual was mapped as (when not using pedigree). Allowed values are [male, female, either] (Default is either)

    --sex=SEX

    sex setting that the individual was mapped as (when not using pedigree). Allowed values are [male, female, either] (Default is either)

     --pedigree=FILEGenome relationships PED file containing sample sex information.

    --pedigree=FILE

    Genome relationships PED file containing sample sex information.

     --sex-z-threshold=NUMThe z-score deviation threshold for sex chromosome consistency (Default is 5.0)

    --sex-z-threshold=NUM

    The z-score deviation threshold for sex chromosome consistency (Default is 5.0)

     --z-threshold=NUMThe z-score deviation threshold for chromosome consistency (Default is 10.0)

    --z-threshold=NUM

    The z-score deviation threshold for chromosome consistency (Default is 10.0)

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -9967,8 +9820,8 @@

    chrstats--bed-regions flag.

    @@ -9988,86 +9841,86 @@

    mendelian +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILEVCF file containing multi-sample variant calls. Use ‘-‘ to read from standard input.

    -i

    --input=FILE

    VCF file containing multi-sample variant calls. Use ‘-‘ to read from standard input.

    -o--output=FILEIf set, output annotated calls to this VCF file. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    If set, output annotated calls to this VCF file. Use ‘-‘ to write to standard output.

     --output-consistent=FILEIf set, output only consistent calls to this VCF file.

    --output-consistent=FILE

    If set, output only consistent calls to this VCF file.

     --output-inconsistent=FILEIf set, output only non-Mendelian calls to this VCF file.

    --output-inconsistent=FILE

    If set, output only non-Mendelian calls to this VCF file.

    -t--template=SDFSDF containing the reference genome.

    -t

    --template=SDF

    SDF containing the reference genome.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --all-recordsUse all records, regardless of filters (Default is to only process records where FILTER is . or PASS)

    --all-records

    Use all records, regardless of filters (Default is to only process records where FILTER is . or PASS)

    -l--lenientAllow homozygous diploid calls in place of haploid calls and assume missing values are equal to the reference.

    -l

    --lenient

    Allow homozygous diploid calls in place of haploid calls and assume missing values are equal to the reference.

     --min-concordance=FLOATPercentage concordance required for consistent parentage (Default is 99.0)

    --min-concordance=FLOAT

    Percentage concordance required for consistent parentage (Default is 99.0)

     --pedigree=FILEGenome relationships PED file (Default is to extract pedigree information from VCF header fields)

    --pedigree=FILE

    Genome relationships PED file (Default is to extract pedigree information from VCF header fields)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    @@ -10133,8 +9986,8 @@

    mendelian--all-records parameter.

    @@ -10153,108 +10006,108 @@

    vcfannotate +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -i--input=FILEVCF file containing variants to annotate. Use ‘-‘ to read from standard input.

    -i

    --input=FILE

    VCF file containing variants to annotate. Use ‘-‘ to read from standard input.

    -o--output=FILEOutput VCF file name. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output VCF file name. Use ‘-‘ to write to standard output.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -A--annotation=STRINGAdd computed annotation to VCF records. Allowed values are [AC, AN, EP, GQD, IC, LAL, MEANQAD, NAA, PD, QA, QD, RA, SCONT, VAF, VAF1, ZY]. May be specified 0 or -more times, or as a comma separated list.

    -A

    --annotation=STRING

    Add computed annotation to VCF records. Allowed values are [AC, AN, EP, GQD, IC, LAL, MEANQAD, NAA, PD, QA, QD, RA, SCONT, VAF, VAF1, ZY]. May be specified 0 or +more times, or as a comma separated list.

     --bed-ids=FILEAdd variant IDs from BED file. May be specified 0 or more times.

    --bed-ids=FILE

    Add variant IDs from BED file. May be specified 0 or more times.

     --bed-info=FILEAdd INFO annotations from BED file. May be specified 0 or more times.

    --bed-info=FILE

    Add INFO annotations from BED file. May be specified 0 or more times.

     --fill-an-acAdd or update the AN and AC INFO fields.

    --fill-an-ac

    Add or update the AN and AC INFO fields.

     --info-description=STRINGIf the BED INFO field is not already declared, use this description in the header (Default is Annotation)

    --info-description=STRING

    If the BED INFO field is not already declared, use this description in the header (Default is Annotation)

     --info-id=STRINGThe INFO ID for BED INFO annotations (Default is ANN)

    --info-id=STRING

    The INFO ID for BED INFO annotations (Default is ANN)

     --relabel=FILERelabel samples according to old-name new-name pairs in specified file.

    --relabel=FILE

    Relabel samples according to old-name new-name pairs in specified file.

     --vcf-ids=FILEAdd variant IDs from VCF file. May be specified 0 or more times.

    --vcf-ids=FILE

    Add variant IDs from VCF file. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -a--add-header=STRING|FILEFile containing VCF header lines to add, or a literal header line. May be specified 0 or more times.

    -a

    --add-header=STRING|FILE

    File containing VCF header lines to add, or a literal header line. May be specified 0 or more times.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-headerPrevent VCF header from being written.

    --no-header

    Prevent VCF header from being written.

    @@ -10299,8 +10152,8 @@

    vcfannotateDCOC, DCOF, OCOC, OCOF.

    @@ -10461,143 +10314,160 @@

    vcfeval +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -b--baseline=FILEVCF file containing baseline variants.

    -b

    --baseline=FILE

    VCF file containing baseline variants.

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -c--calls=FILEVCF file containing called variants.

    -c

    --calls=FILE

    VCF file containing called variants.

    -e--evaluation-regions=FILEIf set, evaluate within regions contained in the supplied BED file, allowing transborder matches. To be used for truth-set high-confidence regions or other -regions of interest where region boundary effects should be minimized.

    -e

    --evaluation-regions=FILE

    If set, evaluate within regions contained in the supplied BED file, allowing transborder matches. To be used for truth-set high-confidence regions or other +regions of interest where region boundary effects should be minimized.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

    -t--template=SDFSDF of the reference genome the variants are called against.

    -t

    --template=SDF

    SDF of the reference genome the variants are called against.

    - +
    ---+++ - - + + - - - - + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --all-recordsUse all records regardless of FILTER status (Default is to only process records where FILTER is . or PASS)

    --all-records

    Use all records regardless of FILTER status (Default is to only process records where FILTER is . or PASS)

    --decompose

    Decompose complex variants into smaller constituents to allow partial credit.

     --decomposeDecompose complex variants into smaller constituents to allow partial credit.

    --ref-overlap

    Allow alleles to overlap where bases of either allele are same-as-ref (Default is to only allow VCF anchor base overlap)

     --ref-overlapAllow alleles to overlap where bases of either allele are same-as-ref (Default is to only allow VCF anchor base overlap)

    --sample=STRING

    The name of the sample to select. Use <baseline_sample>,<calls_sample> to select different sample names for baseline and calls. (Required when using +multi-sample VCF files)

     --sample=STRINGThe name of the sample to select. Use <baseline_sample>,<calls_sample> to select different sample names for baseline and calls. (Required when using -multi-sample VCF files)

    --sample-ploidy=INT

    Expected ploidy of samples (Default is 2)

     --squash-ploidyTreat heterozygous genotypes as homozygous ALT in both baseline and calls, to allow matches that ignore zygosity differences.

    --squash-ploidy

    Treat heterozygous genotypes as homozygous ALT in both baseline and calls, to allow matches that ignore zygosity differences.

    - +
    ---+++ - - + + - - - - + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + + + + + + + + +
    Reporting

    Reporting

     --at-precision=FLOATOutput summary statistics where precision >= supplied value (Default is to summarize at maximum F-measure)

    --at-precision=FLOAT

    Output summary statistics where precision >= supplied value (Default is to summarize at maximum F-measure)

    --at-sensitivity=FLOAT

    Output summary statistics where sensitivity >= supplied value (Default is to summarize at maximum F-measure)

     --at-sensitivity=FLOATOutput summary statistics where sensitivity >= supplied value (Default is to summarize at maximum F-measure)

    --no-roc

    Do not produce ROCs.

     --no-rocDo not produce ROCs.

    -m

    --output-mode=STRING

    Output reporting mode. Allowed values are [split, annotate, combine, ga4gh, roc-only] (Default is split)

    -m--output-mode=STRINGOutput reporting mode. Allowed values are [split, annotate, combine, ga4gh, roc-only] (Default is split)

    --roc-expr=STRING

    Output ROC file for variants matching custom JavaScript expression. Use the form <LABEL>=<EXPRESSION>. May be specified 0 or more times.

    -O--sort-order=STRINGThe order in which to sort the ROC scores so that good scores come before bad scores. Allowed values are [ascending, descending] (Default is descending)

    --roc-regions=STRING

    Output ROC file for variants overlapping custom regions supplied in BED file. Use the form <LABEL>=<FILENAME>. May be specified 0 or more times.

    -f--vcf-score-field=STRINGThe name of the VCF FORMAT field to use as the ROC score. Also valid are QUAL, INFO.<name> or FORMAT.<name> to select the named VCF FORMAT or INFO -field (Default is GQ)

    --roc-subset=STRING

    Output ROC file for preset variant subset. Allowed values are [hom, het, snp, non-snp, mnp, indel]. May be specified 0 or more times, or as a comma separated +list.

    -O

    --sort-order=STRING

    The order in which to sort the ROC scores so that good scores come before bad scores. Allowed values are [ascending, descending] (Default is descending)

    -f

    --vcf-score-field=STRING

    The name of the VCF FORMAT field to use as the ROC score. Also valid are QUAL, INFO.<name> or FORMAT.<name> to select the named VCF FORMAT or INFO +field (Default is GQ)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipSet this flag to create the output files without compression.

    -Z

    --no-gzip

    Do not gzip the output.

    -T--threads=INTSpecify the number of threads to use in a multi-core processor. (Default is all available cores).

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -10668,6 +10538,18 @@

    Common allele matching with

    +
    +

    Comparing non-diploid genomes

    +

    By default, vcfeval assumes diploid organisms (that is, the expected +ploidy of any GT call is 2). As a special case to ease the comparison of +male calls on sex chromosomes (where callers often continue to use +diploid representation), haploid calls are treated as homozygous +diploid. Any calls made with unexpected ploidy are ignored and reported +in the vcfeval log file.

    +

    To compare genomes with non-diploid ploidy, the expected sample ploidy +can be overridden via --sample-ploidy – for example +--sample-ploidy=4 would be used to compare tetraploid organisms.

    +

    Comparing with a VCF that has no sample column

    A common scenario is to match a call set against a baseline which @@ -10691,8 +10573,8 @@

    Comparing with a VCF that has no sample column -

    Note

    -

    It is also possible to run a diploid comparison by omitting +

    Note

    +

    It is also possible to run a diploid comparison by omitting --squash-ploidy, but this is not usually required, and is computationally more intensive since there may be many more possible diploid genotypes to explore, particularly if the ALT VCF contains @@ -10737,17 +10619,17 @@

    Split (--output are not altered in any way, preserving all annotations present in the input files.

      -
    • tp.vcf – contains those variants from the calls VCF which agree -with variants in the baseline VCF
    • -
    • tp-baseline.vcf – contains those variants from the baseline VCF +
    • tp.vcf – contains those variants from the calls VCF which agree +with variants in the baseline VCF

    • +
    • tp-baseline.vcf – contains those variants from the baseline VCF which agree with variants in the calls VCF. Thus, the variants in tp.vcf and tp-baseline.vcf are equivalent. This file can be used to successively refine a highly sensitive baseline variant set to -produce a consensus from several call sets.

    • -
    • fp.vcf – contains variants from the calls VCF which do not agree -with baseline variants.
    • -
    • fn.vcf – contains variants from the baseline VCF which were not -correctly called.
    • +produce a consensus from several call sets.

      +
    • fp.vcf – contains variants from the calls VCF which do not agree +with baseline variants.

    • +
    • fn.vcf – contains variants from the baseline VCF which were not +correctly called.

    This mode performs a single pass comparison, either in diploid mode (the default), or haploid mode (if --squash-ploidy has been set). The @@ -10760,10 +10642,10 @@

    Annotate (--out instead adds INFO annotations containing the match status of each record:

      -
    • calls.vcf – contains variants from the calls VCF, augmented with -match status annotations.
    • -
    • baseline.vcf – contains variants from the baseline VCF, augmented -with match status annotations.
    • +
    • calls.vcf – contains variants from the calls VCF, augmented with +match status annotations.

    • +
    • baseline.vcf – contains variants from the baseline VCF, augmented +with match status annotations.

    This output mode automatically performs two comparison passes, the first finds diploid matches (assigned a match status of TP), and a second @@ -10777,49 +10659,35 @@

    Annotate (--out otherwise containing a non-variant genotype). A status of OUT indicates a VCF record which does not contain a match status due to falling outside the evaluation regions when --evaluation-regions is -being used.

    +being used. The annotated VCF files produced in this mode may also be +used with vcf2rocplot to produce additional post-evaluation ROC data +files.

    -
    Combine (–output-mode=combine)
    +
    Combine (--output-mode=combine)

    This output mode provides an easy way to view the baseline and call variants in a single two-sample VCF.

      -
    • output.vcf – contains variants from both the baseline and calls +
    • output.vcf – contains variants from both the baseline and calls VCFs, augmented with match status annotations. The sample under comparison from each of the input VCFs is extracted as a column in the output. As the VCF records from the baseline and calls typically have very different input annotations which can be difficult to merge, and to keep the output format simple, there is no attempt to -preserve any of the original variant annotations.

    • +preserve any of the original variant annotations.

    As with the annotation output mode, this output mode automatically performs two comparison passes to find both diploid matches and haploid (lenient) matches.

    -
    ROC-only (–output-mode=roc-only)
    +
    ROC-only (--output-mode=roc-only)

    This output mode provides a lightweight way to run performance benchmarking, as VCF file output is omitted, and only ROC data files are produced.

    -

    All of the output modes produce the following ROC data files:

    -
      -
    • weighted_roc.tsv – contains ROC data derived from all analyzed -call variants, regardless of their representation. Columns include -the score field, and standard accuracy metrics such as true -positives, false positives, false negatives, precision, sensitivity, -and f-measure corresponding to each score threshold.
    • -
    • snp_roc.tsv – contains ROC data derived from only those variants -which were represented as SNPs. Since the representation conventions -can differ between the baseline and calls, there are some subtleties -to be aware of when interpreting metrics such as precision, -sensitivity, etc, described below.
    • -
    • non_snp_roc.tsv – contains ROC data derived from those -variants which were not represented as SNPs. As above, not all -metrics are computed for this file.
    • -
    -

    Note

    -

    In addition, vcfeval has an output mode +

    Note

    +

    In addition, vcfeval has an output mode (--output-mode=ga4gh) which produces the intermediate evaluation format defined by the GA4GH Benchmarking Team, without additional statistics files. This mode is not generally intended for end users, @@ -10830,6 +10698,87 @@

    ROC-only (–output-mode=roc-only) +

    Additional ROC stratifications

    +

    All of the output modes produce the following ROC data files (unless +disabled by --no-roc):

    +
      +
    • weighted_roc.tsv – contains ROC data derived from all analyzed +call variants, regardless of their representation. Columns include +the score field, and standard accuracy metrics such as true +positives, false positives, false negatives, precision, sensitivity, +and f-measure corresponding to each score threshold.

    • +
    • snp_roc.tsv – contains ROC data derived from only those variants +which were represented as SNPs. Since the representation conventions +can differ between the baseline and calls, there are some subtleties +to be aware of when interpreting metrics such as precision, +sensitivity, etc, described below.

    • +
    • non_snp_roc.tsv – contains ROC data derived from those +variants which were not represented as SNPs. As above, not all +metrics are computed for this file.

    • +
    +

    vcfeval also provides the ability to produce additional ROC data +files corresponding to preset and customized variant stratifications +with the following flags:

    +
    +
    Preset stratifications
    +

    The --roc-subset flag allows selection from preset stratifications +based on variant type (according to their representation in the +relevant input VCF):

    +
      +
    • hom – homozygous variants only

    • +
    • het – heterozygous variants only

    • +
    • snp – SNP variants (enabled by default)

    • +
    • non-snp – non-SNP variants (enabled by default)

    • +
    • mnp – multi-nucleotide polymorphisms only

    • +
    • indel – length-changing variants only

    • +
    +

    Multiple presets can be enabled in a single run, e.g. --roc-subset hom,het,indel

    +
    +
    +
    Region-based stratifications
    +

    The --roc-regions flag produces a stratified ROC data file using only +variants that overlap regions specified in a user-supplied BED file. The +special syntax for this flag is: --roc-regions LABEL=FILE, where +LABEL is a short tag used to determine ROC output file names and +FILE is the path to the relevant BED file. For example, to produce +additional stratifications based on BED files partitioning the genome +based on GC content:

    +
    $ rtg vcfeval -t build37.sdf -b baseline.vcf.gz -c calls.vcf.gz \
    +  --roc-regions GC55TO60=/path/to/GCcontent/GRCh37_gc55to60_slop50.bed.gz \
    +  --roc-regions GC60TO65=/path/to/GCcontent/GRCh37_gc60to65_slop50.bed.gz
    +
    +
    +
    +
    +
    Custom JavaScript based stratifications
    +

    The above stratification flags will satisfy most common usages, but +vcfeval also includes the ability to write custom stratifications +using JavaScript expressions (similar to vcffilter --keep-expr). The +special syntax for this flag is: --roc-expr LABEL=EXPRESSION, where +LABEL is a short tag used to determine ROC output file names and +EXPRESSION is the JavaScript expression that accepts a variant for +inclusion in the stratification. This is most useful when the input VCFs +contain annotations useful for the stratification. For example, to +produce stratifications based on depth of coverage during variant +calling:

    +
    $ rtg vcfeval -t build37.sdf -b baseline.vcf.gz -c calls.vcf.gz \
    +  --roc-expr "DP10TO20=has(INFO.DP) && INFO.DP>=10 && INFO.DP<20" \
    +  --roc-expr "DP20TO30=has(INFO.DP) && INFO.DP>=20 && INFO.DP<30" \
    +  --roc-expr "DP30TO40=has(INFO.DP) && INFO.DP>=30 && INFO.DP<40"
    +
    +
    +

    Tips:

    +
      +
    • Ensure the expression is valid to evaluate on all variants (for +example, take care when referring to sample fields names if the sample +names are different between baseline and calls files).

    • +
    • It may be useful to test or debug the expression (without the label) +via vcffilter --keep-expr.

    • +
    +

    For more information on JavaScript expressions, see RTG JavaScript filtering API

    +
    +

    Benchmarking comparisons using ROC and precision/sensitivity curves

    Multiple ROC data files (from a single or several vcfeval runs) can @@ -10862,14 +10811,14 @@

    Benchmarking comparisons using ROC and precision/sensitivity curves
    -

    \text{Sensitivity} = \text{TP}_\text{baseline} / (\text{TP}_\text{baseline} + \text{FN}).

    +

    \text{Sensitivity} = \text{TP}_\text{baseline} / (\text{TP}_\text{baseline} + \text{FN}).

    Conversely since false positives can only be measured in terms of the call representation, precision is defined as:

    -

    \text{Precision} = \text{TP}_\text{call} / (\text{TP}_\text{call} + \text{FP}).

    +

    \text{Precision} = \text{TP}_\text{call} / (\text{TP}_\text{call} + \text{FP}).

    Variant decomposition and benchmarking

    @@ -10949,12 +10903,13 @@

    Variant decomposition and benchmarkingrtg vcfdecompose.

    @@ -10978,251 +10933,251 @@

    vcffilter +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --all-samplesApply sample-specific criteria to all samples contained in the input VCF.

    --all-samples

    Apply sample-specific criteria to all samples contained in the input VCF.

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -i--input=FILEVCF file containing variants to be filtered. Use ‘-‘ to read from standard input.

    -i

    --input=FILE

    VCF file containing variants to be filtered. Use ‘-‘ to read from standard input.

    -o--output=FILEOutput VCF file. Use ‘-‘ to write to standard output. This option is required, unless --javascript is being used.

    -o

    --output=FILE

    Output VCF file. Use ‘-‘ to write to standard output. This option is required, unless --javascript is being used.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

     --sample=STRINGApply sample-specific criteria to the named sample contained in the input VCF. May be specified 0 or more times.

    --sample=STRING

    Apply sample-specific criteria to the named sample contained in the input VCF. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering (Record based)

    Filtering (Record based)

    -w--density-window=INTWindow within which multiple variants are discarded.

    -w

    --density-window=INT

    Window within which multiple variants are discarded.

     --exclude-bed=FILEDiscard all variants within the regions in this BED file.

    --exclude-bed=FILE

    Discard all variants within the regions in this BED file.

     --exclude-vcf=FILEDiscard all variants that overlap with the ones in this file.

    --exclude-vcf=FILE

    Discard all variants that overlap with the ones in this file.

     --include-bed=FILEOnly keep variants within the regions in this BED file.

    --include-bed=FILE

    Only keep variants within the regions in this BED file.

     --include-vcf=FILEOnly keep variants that overlap with the ones in this file.

    --include-vcf=FILE

    Only keep variants that overlap with the ones in this file.

    -j--javascript=STRINGJavascript filtering functions for determining whether to keep record. May be either an expression or a file name. May be specified 0 or more times. -See Examples

    -j

    --javascript=STRING

    Javascript filtering functions for determining whether to keep record. May be either an expression or a file name. May be specified 0 or more times. +See Examples

    -e--keep-expr=STRINGRecords for which this expression evaluates to true will be retained. -See Examples

    -e

    --keep-expr=STRING

    Records for which this expression evaluates to true will be retained. +See Examples

    -k--keep-filter=STRINGOnly keep variants with this FILTER tag. May be specified 0 or more times, or as a comma separated list.

    -k

    --keep-filter=STRING

    Only keep variants with this FILTER tag. May be specified 0 or more times, or as a comma separated list.

    -K--keep-info=STRINGOnly keep variants with this INFO tag. May be specified 0 or more times, or as a comma separated list.

    -K

    --keep-info=STRING

    Only keep variants with this INFO tag. May be specified 0 or more times, or as a comma separated list.

     --max-alleles=INTMaximum number of alleles (REF included)

    --max-alleles=INT

    Maximum number of alleles (REF included)

    -C--max-combined-read-depth=INTMaximum allowed combined read depth.

    -C

    --max-combined-read-depth=INT

    Maximum allowed combined read depth.

    -Q--max-quality=FLOATMaximum allowed quality.

    -Q

    --max-quality=FLOAT

    Maximum allowed quality.

     --min-alleles=INTMinimum number of alleles (REF included)

    --min-alleles=INT

    Minimum number of alleles (REF included)

    -c--min-combined-read-depth=INTMinimum allowed combined read depth.

    -c

    --min-combined-read-depth=INT

    Minimum allowed combined read depth.

    -q--min-quality=FLOATMinimum allowed quality.

    -q

    --min-quality=FLOAT

    Minimum allowed quality.

    -r--remove-filter=STRINGRemove variants with this FILTER tag. May be specified 0 or more times, or as a comma separated list.

    -r

    --remove-filter=STRING

    Remove variants with this FILTER tag. May be specified 0 or more times, or as a comma separated list.

    -R--remove-info=STRINGRemove variants with this INFO tag. May be specified 0 or more times, or as a comma separated list.

    -R

    --remove-info=STRING

    Remove variants with this INFO tag. May be specified 0 or more times, or as a comma separated list.

     --remove-overlappingRemove records that overlap with previous records.

    --remove-overlapping

    Remove records that overlap with previous records.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering (Sample based)

    Filtering (Sample based)

    -A--max-ambiguity-ratio=FLOATMaximum allowed ambiguity ratio.

    -A

    --max-ambiguity-ratio=FLOAT

    Maximum allowed ambiguity ratio.

     --max-avr-score=FLOATMaximum allowed AVR score.

    --max-avr-score=FLOAT

    Maximum allowed AVR score.

     --max-denovo-score=FLOATMaximum de novo score threshold.

    --max-denovo-score=FLOAT

    Maximum de novo score threshold.

    -G--max-genotype-quality=FLOATMaximum allowed genotype quality.

    -G

    --max-genotype-quality=FLOAT

    Maximum allowed genotype quality.

    -D--max-read-depth=INTMaximum allowed sample read depth.

    -D

    --max-read-depth=INT

    Maximum allowed sample read depth.

     --min-avr-score=FLOATMinimum allowed AVR score.

    --min-avr-score=FLOAT

    Minimum allowed AVR score.

     --min-denovo-score=FLOATMinimum de novo score threshold.

    --min-denovo-score=FLOAT

    Minimum de novo score threshold.

    -g--min-genotype-quality=FLOATMinimum allowed genotype quality.

    -g

    --min-genotype-quality=FLOAT

    Minimum allowed genotype quality.

    -d--min-read-depth=INTMinimum allowed sample read depth.

    -d

    --min-read-depth=INT

    Minimum allowed sample read depth.

     --non-snps-onlyOnly keep where sample variant is MNP or INDEL.

    --non-snps-only

    Only keep where sample variant is MNP or INDEL.

     --remove-all-same-as-refRemove where all samples are same as reference.

    --remove-all-same-as-ref

    Remove where all samples are same as reference.

     --remove-homRemove where sample is homozygous.

    --remove-hom

    Remove where sample is homozygous.

     --remove-same-as-refRemove where sample is same as reference.

    --remove-same-as-ref

    Remove where sample is same as reference.

     --snps-onlyOnly keep where sample variant is a simple SNP.

    --snps-only

    Only keep where sample variant is a simple SNP.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --clear-failed-samplesRetain failed records, set the sample GT field to missing.

    --clear-failed-samples

    Retain failed records, set the sample GT field to missing.

    -f--fail=STRINGRetain failed records, add the provided label to the FILTER field.

    -f

    --fail=STRING

    Retain failed records, add the provided label to the FILTER field.

    -F--fail-samples=STRINGRetain failed records, add the provided label to the sample FT field.

    -F

    --fail-samples=STRING

    Retain failed records, add the provided label to the sample FT field.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -a--add-header=STRING|FILEFile containing VCF header lines to add, or a literal header line. May be specified 0 or more times.

    -a

    --add-header=STRING|FILE

    File containing VCF header lines to add, or a literal header line. May be specified 0 or more times.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-headerPrevent VCF header from being written.

    --no-header

    Prevent VCF header from being written.

    @@ -11263,8 +11218,8 @@

    vcffilter--javascript, so the --javascript record function will not be called for records filtered out by --keep-expr.

    Simple filtering by JavaScript expression with --keep-expr

    @@ -11331,22 +11286,22 @@

    Simple filtering by JavaScript expression with

    Advanced JavaScript filtering with --javascript

    The --javascript option aims to support more complicated processing -than --keep-expr. permitting modification of the output VCF, or +than --keep-expr, permitting modification of the output VCF, or supporting use cases where the script is tasked to compute and output alternative information in addition to (or instead of) the output VCF. The scripts specified by the user are evaluated once at the start of processing. Two special functions may be defined in a --javascript script, which will then be executed in different contexts:

      -
    • A function with the name record will be executed once for each VCF +
    • A function with the name record will be executed once for each VCF record. If the record function has a return value it must have type boolean. Records which evaluate to true will be retained, while false will be removed. If the record function has no return value then the record will be retained. The record function is applied -after any --keep-expr expression.

    • -
    • A function with the name end will be called once at the end of +after any --keep-expr expression.

    • +
    • A function with the name end will be called once at the end of processing. This allows reporting of summary statistics collected -during the filter process.

    • +during the filter process.

    This --javascript flag may be specified multiple times, they will be evaluated in order, in a shared JavaScript namespace, before VCF @@ -11449,8 +11404,12 @@

    Advanced JavaScript filtering with -

    See also

    -

    snp, +

    See also

    +

    For full details of functions available in --keep-expr and --javascript see RTG JavaScript filtering API

    +

    +
    +

    See also

    +

    snp, family, somatic, population, @@ -11477,90 +11436,90 @@

    vcfmerge +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -I--input-list-file=FILEFile containing a list of VCF format files (1 per line) to be merged.

    -I

    --input-list-file=FILE

    File containing a list of VCF format files (1 per line) to be merged.

    -o--output=FILEOutput VCF file. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output VCF file. Use ‘-‘ to write to standard output.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

     FILE+Input VCF files to merge. May be specified 0 or more times.

    FILE+

    Input VCF files to merge. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Utility

    Utility

    -a--add-header=STRING|FILEFile containing VCF header lines to add, or a literal header line. May be specified 0 or more times.

    -a

    --add-header=STRING|FILE

    File containing VCF header lines to add, or a literal header line. May be specified 0 or more times.

    -f--force-merge=STRINGAllow merging of specified header ID even when descriptions do not match. May be specified 0 or more times, or as a comma separated list.

    -f

    --force-merge=STRING

    Allow merging of specified header ID even when descriptions do not match. May be specified 0 or more times, or as a comma separated list.

    -F--force-merge-allAttempt merging of all non-matching header declarations.

    -F

    --force-merge-all

    Attempt merging of all non-matching header declarations.

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-headerPrevent VCF header from being written.

    --no-header

    Prevent VCF header from being written.

     --no-merge-altsDo not merge multiple records if the ALTs are different.

    --no-merge-alts

    Do not merge multiple records if the ALTs are different.

     --no-merge-recordsDo not merge multiple records at the same position into one.

    --no-merge-records

    Do not merge multiple records at the same position into one.

     --preserve-formatsDo not merge multiple records containing unmergeable FORMAT fields (Default is to remove those FORMAT fields so the variants can be combined)

    --preserve-formats

    Do not merge multiple records containing unmergeable FORMAT fields (Default is to remove those FORMAT fields so the variants can be combined)

     --statsOutput statistics for the merged VCF file.

    --stats

    Output statistics for the merged VCF file.

    @@ -11611,8 +11570,8 @@

    Merging records at the same positionA, G, or R annotations, or contain the same sample.

    -

    See also

    -

    snp, +

    See also

    +

    snp, family, population, somatic, @@ -11638,79 +11597,79 @@

    vcfsplit +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -i--input=FILEThe input VCF, or ‘-‘ to read from standard input.

    -i

    --input=FILE

    The input VCF, or ‘-‘ to read from standard input.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --keep-refKeep records where the sample is reference.

    --keep-ref

    Keep records where the sample is reference.

     --keep-sample=STRING|FILEFile containing sample IDs to select, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

    --keep-sample=STRING|FILE

    File containing sample IDs to select, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

     --remove-sample=STRING|FILEFile containing sample IDs to ignore, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

    --remove-sample=STRING|FILE

    File containing sample IDs to ignore, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    @@ -11725,8 +11684,8 @@

    vcfsplit--keep-ref is used.

    @@ -11761,66 +11720,66 @@

    vcfstats +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --knownSet to only calculate statistics for known variants.

    --known

    Set to only calculate statistics for known variants.

     --novelSet to only calculate statistics for novel variants.

    --novel

    Set to only calculate statistics for novel variants.

     --sample=FILESet to only calculate statistics for the specified sample. (Default is to include all samples). May be specified 0 or more times.

    --sample=FILE

    Set to only calculate statistics for the specified sample. (Default is to include all samples). May be specified 0 or more times.

     FILE+VCF file from which to derive statistics. Use ‘-‘ to read from standard input. Must be specified 1 or more times.

    FILE+

    VCF file from which to derive statistics. Use ‘-‘ to read from standard input. Must be specified 1 or more times.

    - +
    ---+++ - - + + - - - - + + + +
    Reporting

    Reporting

     --allele-lengthsSet to output variant length histogram.

    --allele-lengths

    Set to output variant length histogram.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -11866,8 +11825,8 @@

    vcfstats -

    See also

    -

    snp, +

    See also

    +

    snp, family, somatic, vcffilter, @@ -11888,123 +11847,123 @@

    vcfsubset +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -i--input=FILEVCF file containing variants to manipulate. Use ‘-‘ to read from standard input.

    -i

    --input=FILE

    VCF file containing variants to manipulate. Use ‘-‘ to read from standard input.

    -o--output=FILEOutput VCF file. Use ‘-‘ to write to standard output.

    -o

    --output=FILE

    Output VCF file. Use ‘-‘ to write to standard output.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --keep-filter=STRINGKeep the specified FILTER tag. May be specified 0 or more times, or as a comma separated list.

    --keep-filter=STRING

    Keep the specified FILTER tag. May be specified 0 or more times, or as a comma separated list.

     --keep-format=STRINGKeep the specified FORMAT field. May be specified 0 or more times, or as a comma separated list.

    --keep-format=STRING

    Keep the specified FORMAT field. May be specified 0 or more times, or as a comma separated list.

     --keep-info=STRINGKeep the specified INFO tag. May be specified 0 or more times, or as a comma separated list.

    --keep-info=STRING

    Keep the specified INFO tag. May be specified 0 or more times, or as a comma separated list.

     --keep-sample=STRING|FILEFile containing sample IDs to keep, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

    --keep-sample=STRING|FILE

    File containing sample IDs to keep, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

     --remove-filter=STRINGRemove the specified FILTER tag. May be specified 0 or more times, or as a comma separated list.

    --remove-filter=STRING

    Remove the specified FILTER tag. May be specified 0 or more times, or as a comma separated list.

     --remove-filtersRemove all FILTER tags.

    --remove-filters

    Remove all FILTER tags.

     --remove-format=STRINGRemove the specified FORMAT field. May be specified 0 or more times, or as a comma separated list.

    --remove-format=STRING

    Remove the specified FORMAT field. May be specified 0 or more times, or as a comma separated list.

     --remove-idsRemove the contents of the ID field.

    --remove-ids

    Remove the contents of the ID field.

     --remove-info=STRINGRemove the specified INFO tag. May be specified 0 or more times, or as a comma separated list.

    --remove-info=STRING

    Remove the specified INFO tag. May be specified 0 or more times, or as a comma separated list.

     --remove-infosRemove all INFO tags.

    --remove-infos

    Remove all INFO tags.

     --remove-qualRemove the QUAL field.

    --remove-qual

    Remove the QUAL field.

     --remove-sample=STRING|FILEFile containing sample IDs to remove, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

    --remove-sample=STRING|FILE

    File containing sample IDs to remove, or a literal sample name. May be specified 0 or more times, or as a comma separated list.

     --remove-samplesRemove all samples.

    --remove-samples

    Remove all samples.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

     --no-headerPrevent VCF header from being written.

    --no-header

    Prevent VCF header from being written.

    @@ -12017,8 +11976,8 @@

    vcfsubset--keep-format GT --keep-format DP is equivalent to –keep-format GT,DP.

    -

    See also

    -

    snp, +

    See also

    +

    snp, family, somatic, population, @@ -12026,6 +11985,158 @@

    vcfsubsetvcfannotate

    +
    +

    vcf2rocplot

    +

    Synopsis:

    +

    Produce rocplot compatible ROC data files from vcfeval annotated +VCFs. The primary use cases for this command are to produce aggregate +ROCs from several independent vcfeval evaluation runs, and to +generate ROCs with respect to different criteria than were used during +the initial vcfeval evaluation.

    +

    Syntax:

    +
    $ rtg vcf2rocplot [OPTION]... -o DIR FILE+
    +
    +
    +

    Create an aggregate ROC from evaluations of several independent samples:

    +
    $ rtg vcfeval -b goldstandard.vcf.gz -c snps.vcf.gz -t HUMAN_reference \
    +  --sample daughter1 -f AVR -o eval -m annotate
    +$ rtg vcfeval -b goldstandard.vcf.gz -c snps.vcf.gz -t HUMAN_reference \
    +  --sample daughter2 -f AVR -o eval -m annotate
    +$ rtg vcfeval -b goldstandard.vcf.gz -c snps.vcf.gz -t HUMAN_reference \
    +  --sample son2 -f AVR -o eval -m annotate
    +$ rtg vcf2rocplot -o eval_family -f AVR \
    +  eval_{daughter1,daughter2,son1}/{baseline,calls}.vcf.gz
    +$ rtg rocplot eval_family/weighted_roc.tsv.gz \
    +  --png eval_family_roc.png
    +
    +
    +

    Parameters:

    + +++++ + + + + + + + + + + + + + + + + + + + + + + +

    File Input/Output

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -o

    --output=DIR

    Directory for output.

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

    FILE+

    Input VCF files containing vcfeval annotations. Must be specified 1 or more times.

    + +++++ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

    Reporting

    --at-precision=FLOAT

    Output summary statistics where precision >= supplied value (Default is to summarize at maximum F-measure)

    --at-sensitivity=FLOAT

    Output summary statistics where sensitivity >= supplied value (Default is to summarize at maximum F-measure)

    --roc-expr=STRING

    Output ROC file for variants matching custom JavaScript expression. Use the form <LABEL>=<EXPRESSION>. May be specified 0 or more times.

    --roc-regions=STRING

    Output ROC file for variants overlapping custom regions supplied in BED file. Use the form <LABEL>=<FILENAME>. May be specified 0 or more times.

    --roc-subset=STRING

    Output ROC file for preset variant subset. Allowed values are [hom, het, snp, non-snp, mnp, indel]. May be specified 0 or more times, or as a comma separated +list.

    -O

    --sort-order=STRING

    The order in which to sort the ROC scores so that good scores come before bad scores. Allowed values are [ascending, descending] (Default is descending)

    -f

    --vcf-score-field=STRING

    The name of the VCF FORMAT field to use as the ROC score. Also valid are QUAL, INFO.<name> or FORMAT.<name> to select the named VCF FORMAT or INFO +field (Default is GQ)

    + +++++ + + + + + + + + + + + + + + + + + + +

    Utility

    -h

    --help

    Print help on command-line flag usage.

    -Z

    --no-gzip

    Do not gzip the output.

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    +

    Usage:

    +

    While the ROC outputs generated by vcfeval are sufficient for many +scenarios, there are some situations where it is useful to regenerate +ROC files from one or more existing vcfeval outputs.

    +

    One such situation is when evaluating caller accuracy across a cohort of +samples where the number of variants per individual sample is +low. Individual sample ROC curves are fairly uninformative with regard +to overall accuracy or where to place suitable filter thresholds. An ROC +curve from the combined evaluations provides a much better indication of +overall caller accuracy.

    +

    Another use case for generating ROC files from an existing vcfeval +run is to look at alternative scoring methods or stratifications without +having to execute the time-consuming variant matching stage implied by a +new vcfeval run.

    +

    The prerequisite for using vcf2rocplot is that vcfeval must +have been run in “annotation” mode (i.e. via --output-mode=annotate) +so that the output VCF files contain sufficient annotations regarding +variant classification status. It is important that vcf2rocplot be +provided with both annotated baseline and call VCFs in order to produce +correct outputs.

    +

    The operation of the various score field selection and ROC +stratification flags works the same as when running vcfeval.

    +
    +

    See also

    +

    rocplot, +vcfeval

    +
    +

    @@ -12132,113 +12243,113 @@

    bndeval +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

    -b--baseline=FILEVCF file containing baseline variants.

    -b

    --baseline=FILE

    VCF file containing baseline variants.

     --bed-regions=FILEIf set, only read VCF records that overlap the ranges contained in the specified BED file.

    --bed-regions=FILE

    If set, only read VCF records that overlap the ranges contained in the specified BED file.

    -c--calls=FILEVCF file containing called variants.

    -c

    --calls=FILE

    VCF file containing called variants.

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     --region=REGIONIf set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or -<sequence_name>:<pos>~<padding>

    --region=REGION

    If set, only read VCF records within the specified range. The format is one of <sequence_name>, <sequence_name>:<start>-<end>, <sequence_name>:<pos>+<length> or +<sequence_name>:<pos>~<padding>

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --all-recordsUse all records regardless of FILTER status (Default is to only process records where FILTER is “.” or “PASS”)

    --all-records

    Use all records regardless of FILTER status (Default is to only process records where FILTER is “.” or “PASS”)

     --bidirectionalIf set, allow matches between flipped breakends.

    --bidirectional

    If set, allow matches between flipped breakends.

     --tolerance=INTPositional tolerance for breakend matching (Default is 100)

    --tolerance=INT

    Positional tolerance for breakend matching (Default is 100)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

     --no-rocDo not produce ROCs.

    --no-roc

    Do not produce ROCs.

    -m--output-mode=STRINGOutput reporting mode. Allowed values are [split, annotate] (Default is split)

    -m

    --output-mode=STRING

    Output reporting mode. Allowed values are [split, annotate] (Default is split)

    -O--sort-order=STRINGThe order in which to sort the ROC scores so that good scores come before bad scores. Allowed values are [ascending, descending] (Default is descending)

    -O

    --sort-order=STRING

    The order in which to sort the ROC scores so that good scores come before bad scores. Allowed values are [ascending, descending] (Default is descending)

    -f--vcf-score-field=STRINGThe name of the VCF FORMAT field to use as the ROC score. Also valid are QUAL, INFO.<name> or FORMAT.<name> to select the named VCF FORMAT or INFO -field (Default is INFO.DP)

    -f

    --vcf-score-field=STRING

    The name of the VCF FORMAT field to use as the ROC score. Also valid are QUAL, INFO.<name> or FORMAT.<name> to select the named VCF FORMAT or INFO +field (Default is INFO.DP)

    - +
    ---+++ - - + + - - - - + + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    -Z--no-gzipDo not gzip the output.

    -Z

    --no-gzip

    Do not gzip the output.

    @@ -12276,21 +12387,21 @@

    bndeval outputsbndeval command produces summary statistics and the following primary result files in the output directory:

      -
    • weighted_roc.tsv.gz - contains ROC data that can be plotted -with rocplot
    • -
    • baseline.bed.gz contains the truth breakend regions, where each BED +
    • weighted_roc.tsv.gz - contains ROC data that can be plotted +with rocplot

    • +
    • baseline.bed.gz contains the truth breakend regions, where each BED record contains the region status as TP or FN, the SVTYPE, -and the span of the original truth VCF record.

    • -
    • calls.bed.gz contains the called breakend regions, where each BED +and the span of the original truth VCF record.

    • +
    • calls.bed.gz contains the called breakend regions, where each BED record contains the region status as TP or FP, the SVTYPE, the span of the original calls VCF record, and the score value used -for ranking in the ROC plot.

    • -
    • summary.txt contains the same summary statistics printed to -standard output.
    • +for ranking in the ROC plot.

      +
    • summary.txt contains the same summary statistics printed to +standard output.

    -

    See also

    -

    discord, +

    See also

    +

    discord, svdecompose, vcfeval, rocplot

    @@ -12310,83 +12421,83 @@

    pedfilter +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

     FILEThe pedigree file to process, may be PED or VCF, use ‘-‘ to read from stdin.

    FILE

    The pedigree file to process, may be PED or VCF, use ‘-‘ to read from stdin.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

     --keep-family=STRINGKeep only individuals with the specified family ID. May be specified 0 or more times, or as a comma separated list.

    --keep-family=STRING

    Keep only individuals with the specified family ID. May be specified 0 or more times, or as a comma separated list.

     --keep-ids=STRINGKeep only individuals with the specified ID. May be specified 0 or more times, or as a comma separated list.

    --keep-ids=STRING

    Keep only individuals with the specified ID. May be specified 0 or more times, or as a comma separated list.

     --keep-primaryKeep only primary individuals (those with a PED individual line / VCF sample column)

    --keep-primary

    Keep only primary individuals (those with a PED individual line / VCF sample column)

     --remove-parentageRemove all parent-child relationship information.

    --remove-parentage

    Remove all parent-child relationship information.

    - +
    ---+++ - - + + - - - - + + + +
    Reporting

    Reporting

     --vcfOutput pedigree in in the form of a VCF header rather than PED.

    --vcf

    Output pedigree in in the form of a VCF header rather than PED.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -12401,8 +12512,8 @@

    pedfilter -

    See also

    -

    family, +

    See also

    +

    family, population, mendelian, pedstats

    @@ -12447,90 +12558,90 @@

    pedstats +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

     FILEThe pedigree file to process, may be PED or VCF, use ‘-‘ to read from stdin.

    FILE

    The pedigree file to process, may be PED or VCF, use ‘-‘ to read from stdin.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Reporting

    Reporting

    -d--delimiter=STRINGOutput id lists using this separator (Default is \n)

    -d

    --delimiter=STRING

    Output id lists using this separator (Default is \n)

     --dot=STRINGOutput pedigree in Graphviz format, using the supplied text as a title.

    --dot=STRING

    Output pedigree in Graphviz format, using the supplied text as a title.

     --familiesOutput information about family structures.

    --families

    Output information about family structures.

     --female-idsOutput ids of all females.

    --female-ids

    Output ids of all females.

     --founder-idsOutput ids of all founders.

    --founder-ids

    Output ids of all founders.

     --male-idsOutput ids of all males.

    --male-ids

    Output ids of all males.

     --maternal-idsOutput ids of maternal individuals.

    --maternal-ids

    Output ids of maternal individuals.

     --paternal-idsOutput ids of paternal individuals.

    --paternal-ids

    Output ids of paternal individuals.

     --primary-idsOutput ids of all primary individuals.

    --primary-ids

    Output ids of all primary individuals.

     --simple-dotWhen outputting Graphviz format, use a layout that looks less like a traditional pedigree diagram but works better with large complex pedigrees.

    --simple-dot

    When outputting Graphviz format, use a layout that looks less like a traditional pedigree diagram but works better with large complex pedigrees.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -12581,14 +12692,14 @@

    pedstats
    -

    See also

    -

    family, +

    See also

    +

    family, population, pedfilter, vcfsubset

    @@ -12607,37 +12718,37 @@

    avrstats +---+++ - - + + - - - - + + + +
    Reporting

    Reporting

     MODELName of AVR model to use when scoring variants.

    MODEL

    Name of AVR model to use when scoring variants.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -12646,8 +12757,8 @@

    avrstats -

    See also

    -

    avrbuild, +

    See also

    +

    avrbuild, avrpredict, snp, family, @@ -12671,90 +12782,103 @@

    rocplot +---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    File Input/Output

    File Input/Output

     --curve=STRINGROC data file with title optionally specified (path[=title]). May be specified 0 or more times.

    --curve=STRING

    ROC data file with title optionally specified (path[=title]). May be specified 0 or more times.

     --png=FILEIf set, output a PNG image to the given file.

    --png=FILE

    If set, output a PNG image to the given file.

     --svg=FILEIf set, output a SVG image to the given file.

    --svg=FILE

    If set, output a SVG image to the given file.

     --zoom=STRINGShow a zoomed view with the given coordinates, supplied in the form <xmax>,<ymax> or <xmin>,<ymin>,<xmax>,<ymax>

    --zoom=STRING

    Show a zoomed view with the given coordinates, supplied in the form <xmax>,<ymax> or <xmin>,<ymin>,<xmax>,<ymax>

     FILE+ROC data file. May be specified 0 or more times.

    FILE+

    ROC data file. May be specified 0 or more times.

    - +
    ---+++ - - + + - - - - + + + + + + + + + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + + + + +
    Reporting

    Reporting

     --hide-sidepaneIf set, hide the side pane from the GUI on startup.

    --cmd=FILE

    If set, print rocplot command used in previously saved image.

    --hide-sidepane

    If set, hide the side pane from the GUI on startup.

    --interpolate

    If set, interpolate curves at regular intervals.

     --interpolateIf set, interpolate curves at regular intervals.

    --line-width=INT

    Sets the plot line width (Default is 2)

     --line-width=INTSets the plot line width (Default is 2)

    --palette=STRING

    Name of color palette to use. Allowed values are [blind_13, blind_15, blind_8, brewer_accent, brewer_dark2, brewer_paired, brewer_pastel1, brewer_pastel2, +brewer_set1, brewer_set2, brewer_set3, classic] (Default is classic)

    -P--precision-sensitivityIf set, plot precision vs sensitivity rather than ROC.

    --plain

    If set, use a plain plot style.

     --scoresIf set, show scores on the plot.

    -P

    --precision-sensitivity

    If set, plot precision vs sensitivity rather than ROC.

    -t--title=STRINGTitle for the plot.

    --scores

    If set, show scores on the plot.

    -t

    --title=STRING

    Title for the plot.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

    @@ -12803,6 +12927,15 @@

    rocplot--interpolate option.

    +

    The default ROC graphs include some flourishes such as background +gradients and axes drop shadows, these can be disabled via the +--plain parameter. Alternative preset color palettes for the curve +colors may be selected with the --palette parameter, and in +particular some palettes are more color-blind friendly than the default +palette. In addition, PNG images saved by rocplot include metadata +indicating the graph configuration that may be useful when recreating +graphs. This metadata can be displayed (when present) via the --cmd +parameter.

    Interactive GUI

    The following image shows the rocplot GUI with an example ROC plot :

    @@ -12811,65 +12944,66 @@

    Interactive GUI

    Some quick tips for the interactive GUI:

      -
    • Select regions within the graph to zoom in. Right click within the +
    • Select regions within the graph to zoom in. Right click within the graph area to bring up a context menu that allows undoing the zoom one -level at a time, or resetting the zoom to the default.

    • -
    • The graph right click menu also allows exporting the image as PNG or -SVG. (The saved image does not include the RTG banner or background -gradient).
    • -
    • Click on a spot in the graph to show the equivalent accuracy metrics +level at a time, or resetting the zoom to the default.

    • +
    • The graph right click menu also allows exporting the image as PNG or +SVG. (The saved image does not include the RTG banner).

    • +
    • Click on a spot in the graph to show the equivalent accuracy metrics for that location in the status bar. Clicking to the left or below the axes will remove the cross-hair. Note that sensitivity depends on the baseline total number of variants being correct. If for example the ROC curve corresponds to evaluating an exome call-set against a -whole-genome baseline, this number will be inaccurate.

    • -
    • A secondary cross-hair is also available by holding down shift when +whole-genome baseline, this number will be inaccurate.

    • +
    • A secondary cross-hair is also available by holding down shift when placing (or removing) the cross-hair. When two cross-hairs are placed or moved, metrics in the status bar indicate the difference between -the two positions.

    • -
    • Additional ROC data files can be loaded by clicking on the “Open…” +the two positions.

    • +
    • Additional ROC data files can be loaded by clicking on the “Open…” button, and multiple ROC data files within a directory can be loaded -at once using multi-select.

    • -
    • The “Cmd” button will open a message window that contains a +at once using multi-select. Alternatively, you may use Drag and Drop +from your file browser to drop ROC data files into either the graph +area or the right hand ROC curve widget area.

    • +
    • The “Cmd” button will open a message window that contains a command-line equivalent to the currently displayed set of curves. This command-line may be copy-pasted, providing an easy way to replicate the current set of curves in another session, generate a curve in a -script, or share with a colleague.

    • -
    • There is a drop down that allows for switching between ROC and -precision/sensitivity graph types.
    • +script, or share with a colleague.

      +
    • There is a drop down that allows for switching between ROC and +precision/sensitivity graph types.

    Each curve in the GUI has a customization widget on the right hand side of the window that allows several operations:

      -
    • Rename the title used for the curve via the editable text.
    • -
    • Temporarily hide/show the curve via selection checkbox.
    • -
    • Reorder curves via drag and drop using the colored handle on the left.
    • -
    • Right click within the ROC widget area to bring up a context menu that +
    • Rename the title used for the curve via the editable text.

    • +
    • Temporarily hide/show the curve via selection checkbox.

    • +
    • Reorder curves via drag and drop using the colored handle on the left.

    • +
    • Right click within the ROC widget area to bring up a context menu that allows permanently removing that curve, or customizing the color used -for the curve

    • -
    • Each curve has a slider to simulate the effect of applying a threshold +for the curve

    • +
    • Each curve has a slider to simulate the effect of applying a threshold on the scoring attribute. If the “show scores” option is set, this provides an easy way to select appropriate filter threshold values, which you might apply to variant sets using rtg vcffilter or -similar VCF filtering tools.

    • +similar VCF filtering tools.

    -

    Note

    -

    For a description of the precision/sensitivity interpolation, +

    Note

    +

    For a description of the precision/sensitivity interpolation, see: “The relationship between Precision-Recall and ROC curves”, Davis, J., (2006), https://dx.doi.org/10.1145/1143844.1143874

    -

    See also

    -

    readsimeval, +

    See also

    +

    readsimeval, bndeval, vcfeval

    @@ -12886,82 +13020,82 @@

    hashdist +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -o--output=DIRDirectory for output.

    -o

    --output=DIR

    Directory for output.

     SDFSDF containing sequence data to analyse.

    SDF

    SDF containing sequence data to analyse.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Sensitivity Tuning

    Sensitivity Tuning

     --blacklist-threshold=INTIf set, output a blacklist containing all k-mer hashes with counts exceeding this value.

    --blacklist-threshold=INT

    If set, output a blacklist containing all k-mer hashes with counts exceeding this value.

     --hashmap-size-factor=FLOATMultiplier for the minimum size of the hash map (Default is 1.0)

    --hashmap-size-factor=FLOAT

    Multiplier for the minimum size of the hash map (Default is 1.0)

     --max-count=INTSoft minimum for hash count (i.e. will record exact counts of at least this value) (Default is 500)

    --max-count=INT

    Soft minimum for hash count (i.e. will record exact counts of at least this value) (Default is 500)

    -s--step=INTStep size (Default is 1)

    -s

    --step=INT

    Step size (Default is 1)

    -w--word=INTNumber of bases in each hash (Default is 22)

    -w

    --word=INT

    Number of bases in each hash (Default is 22)

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrint help on command-line flag usage.

    -h

    --help

    Print help on command-line flag usage.

     --install-blacklistInstall the blacklist into the SDF for use during mapping.

    --install-blacklist

    Install the blacklist into the SDF for use during mapping.

    -T--threads=INTNumber of threads (Default is the number of available cores)

    -T

    --threads=INT

    Number of threads (Default is the number of available cores)

    @@ -12989,8 +13123,8 @@

    hashdist -

    See also

    -

    map

    +

    See also

    +

    map

    @@ -13009,37 +13143,37 @@

    ncbi2tax +---+++ - - + + - - - - + + + +
    File Input/Output

    File Input/Output

     DIRDirectory containing the NCBI taxonomy dump.

    DIR

    Directory containing the NCBI taxonomy dump.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -13052,8 +13186,8 @@

    ncbi2taxRTG taxonomic reference file format.

    -

    See also

    -

    format, +

    See also

    +

    format, species, taxfilter, taxstats

    @@ -13073,82 +13207,82 @@

    taxfilter +---+++ - - + + - - - - + + + + - - - + + +
    File Input/Output

    File Input/Output

    -i--input=FILETaxonomy input. May be either a taxonomy TSV file or an SDF containing taxonomy information.

    -i

    --input=FILE

    Taxonomy input. May be either a taxonomy TSV file or an SDF containing taxonomy information.

    -o--output=FILEFilename for output TSV or SDF.

    -o

    --output=FILE

    Filename for output TSV or SDF.

    - +
    ---+++ - - + + - - - - + + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + + - - - + + +
    Filtering

    Filtering

    -P--prune-below-internal-sequencesWhen filtering an SDF, remove nodes below the first containing sequence data.

    -P

    --prune-below-internal-sequences

    When filtering an SDF, remove nodes below the first containing sequence data.

    -p--prune-internal-sequencesWhen filtering an SDF, exclude sequence data from non-leaf output nodes.

    -p

    --prune-internal-sequences

    When filtering an SDF, exclude sequence data from non-leaf output nodes.

    -r--remove=FILEFile containing ids of nodes to remove.

    -r

    --remove=FILE

    File containing ids of nodes to remove.

    -R--remove-sequences=FILEFile containing ids of nodes to remove sequence data from (if any).

    -R

    --remove-sequences=FILE

    File containing ids of nodes to remove sequence data from (if any).

     --rename-norank=FILEAssign a rank to “no rank” nodes from file containing id/rank pairs.

    --rename-norank=FILE

    Assign a rank to “no rank” nodes from file containing id/rank pairs.

    -s--subset=FILEFile containing ids of nodes to include in subset.

    -s

    --subset=FILE

    File containing ids of nodes to include in subset.

    -S--subtree=FILEFile containing ids of nodes to include as subtrees in subset.

    -S

    --subtree=FILE

    File containing ids of nodes to include as subtrees in subset.

    - +
    ---+++ - - + + - - - - + + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    @@ -13191,8 +13325,8 @@

    taxfiltersdf2fasta command with the --taxon flag.

    @@ -13329,28 +13463,28 @@

    usageserver +---+++ - - + + - - - - + + + + - - - + + + - - - + + +
    Utility

    Utility

    -h--helpPrints help on command-line flag usage.

    -h

    --help

    Prints help on command-line flag usage.

    -p--port=INTSet this flag to change which port to listen for usage logging connections. (Default is 8080).

    -p

    --port=INT

    Set this flag to change which port to listen for usage logging connections. (Default is 8080).

    -T--threads=INTSet this flag to change the number of threads for handling incoming connections. (Default is 4).

    -T

    --threads=INT

    Set this flag to change the number of threads for handling incoming connections. (Default is 4).

    @@ -13398,8 +13532,8 @@

    versionversion command to display release and version information.

    @@ -13422,8 +13556,8 @@

    license -

    See also

    -

    help, +

    See also

    +

    help, version

    @@ -13450,8 +13584,8 @@

    help

    Use the help command to view syntax and usage information for the main rtg command as well as individual RTG commands.

    @@ -13459,9 +13593,161 @@

    help

    +
    +
    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/search.html b/installer/resources/core/RTGOperationsManual/search.html index c5ee8af27..98c6ccc11 100644 --- a/installer/resources/core/RTGOperationsManual/search.html +++ b/installer/resources/core/RTGOperationsManual/search.html @@ -2,33 +2,29 @@ - + - - - Search — RTG Core Operations Manual v3.11 + + + Search — RTG Core Operations Manual v3.12 - - - - - - - + + + + + + + - - - + @@ -38,16 +34,10 @@

    Navigation

  • index
  • - + + - - +
    @@ -56,20 +46,18 @@

    Navigation

    Search

    - +

    Please activate JavaScript to enable the search functionality.

    - From here you can search these documents. Enter your search - words into the box below and click "search". Note that the search - function will automatically search for all of the words. Pages - containing fewer words won't appear in the result list. + Searching for multiple words only shows matches that contain + all words.

    - +
    @@ -78,9 +66,17 @@

    Search

    +
    +
    \ No newline at end of file diff --git a/installer/resources/core/RTGOperationsManual/searchindex.js b/installer/resources/core/RTGOperationsManual/searchindex.js index 990071f4c..39a20b590 100644 --- a/installer/resources/core/RTGOperationsManual/searchindex.js +++ b/installer/resources/core/RTGOperationsManual/searchindex.js @@ -1 +1 @@ -Search.setIndex({docnames:["administration","appendix","index","overview","product_usage","rtg_command_reference"],envversion:{"sphinx.domains.c":1,"sphinx.domains.changeset":1,"sphinx.domains.cpp":1,"sphinx.domains.javascript":1,"sphinx.domains.math":2,"sphinx.domains.python":1,"sphinx.domains.rst":1,"sphinx.domains.std":1,sphinx:54},filenames:["administration.rst","appendix.rst","index.rst","overview.rst","product_usage.rst","rtg_command_reference.rst"],objects:{},objnames:{},objtypes:{},terms:{"0_07":0,"0_161":5,"0bfc":0,"0daf":1,"0gb":5,"0x02":1,"0x08":1,"0x100":1,"1000g_v37_phase2":4,"1000genom":4,"100m":4,"1219061gi":1,"143_____1":1,"15_grch38":4,"15_grch38_no_alt_plus_hs38d1_analysis_set":4,"16g":5,"1b19":1,"1i11":1,"1i14":1,"1r1":1,"1r2":1,"1r5":1,"1r5n10":1,"1sampl":5,"1t2":1,"1x1":1,"1x11":1,"1x15":1,"1x19":1,"20human":4,"20humans_an_ac":4,"20humans_prior":4,"283m1d1i32n8m":1,"2a36ba21397":1,"2b20":1,"2b5":1,"2sampl":5,"2x18":1,"2x46":1,"314_pool30":4,"36c48ec4":1,"3gb":5,"3sampl":5,"4157329b":1,"419a":1,"41d195dec4cd":1,"44116e7a2195":1,"454_pe":5,"454_read":5,"454_sdf":5,"454_se":5,"455d":1,"467b":4,"48d5":1,"48e6":1,"48g":[0,1,3],"4b11":1,"4d74":1,"4ecc9eb83e0ccec4":1,"4f6c2eca":0,"52b7":1,"5c2ee18":1,"5n10":1,"5n23":1,"5n25":1,"5n8":1,"6236f4e":5,"6aef897c3d6ff0c78aff06ac189178dd":4,"70s":1,"718f8317b7":5,"71dce5dba129":1,"73e374719c7f":4,"7798b1a5":1,"79d6626":1,"7ded37d7":4,"7f77":1,"817f":4,"86b4f8e98fa6":1,"8acc8413":1,"96ca":1,"976e":1,"9f7b8a5":1,"boolean":5,"break":[1,3,4,5],"byte":3,"case":[0,1,3,4,5],"class":5,"default":[0,1,3,4,5],"export":5,"final":[4,5],"float":[1,5],"function":[2,4],"import":[1,4,5],"int":5,"long":[1,5],"na\u00efv":5,"new":[0,1,3,4,5],"null":[1,5],"public":[1,3,4],"return":[1,5],"short":[1,3,4,5],"switch":[3,4,5],"throw":5,"true":[0,5],"try":4,"typeof":5,"var":[1,5],"while":[1,4,5],ADE:1,AND:1,ARE:1,Adding:[0,1],And:[1,5],BOING:1,BUT:1,But:1,DHS:1,DOING:1,DOS:5,Doing:5,FOR:1,For:[0,1,3,4,5],IDs:[1,3,4,5],INS:5,NCS:[1,4,5],NOT:1,Not:[4,5],One:[1,3,4,5],SAS:3,SUCH:1,Such:[1,5],THE:1,The:[0,1,3,4,5],Then:[0,4,5],There:[1,3,4,5],These:[0,1,3,4,5],USE:1,Use:[0,1,2,3,5],Used:[1,5],Uses:5,Using:[2,3,5],WGS:5,WITH:1,Will:1,With:[0,1,3,4,5],_____27:1,_indel:5,_renam:5,a10:1,a7da:4,aagtacttcttagttcaattactatcatcatcttacctaattactact:1,aat:1,aatacttttcattctttactattacttacttattcttacttacttact:1,abbrevi:5,abc:1,aberr:[3,5],abi:1,abil:[0,3,4,5],abl:[1,4,5],abnorm:[4,5],about:[1,3,4,5],abov:[0,1,4,5],abp:[1,4],abs:5,absenc:5,absent:5,absolut:5,abund:[1,2,4,5],acaryochloris_marina:1,accacct:1,accept:[1,3,4,5],access:[0,2,3,4,5],accessor:1,accg:1,accgttgactctgtgacgctgcacgtacgt:1,accommod:[3,4],accompani:[1,3,5],accomplish:[1,3,4,5],accord:[3,4,5],accordingli:5,account:[1,4,5],accumul:[1,3],accur:[1,4,5],accuraci:[3,4,5],acgc:5,acgt:1,achiev:[4,5],acholeplasma_laidlawii:1,acid:[1,5],acidiphilium_cryptum:1,acidobacteria_bacterium:1,acidothermus_cellulolyticu:1,acidovorax_avena:1,across:[1,3,4,5],act:5,action:1,actual:[1,3,4,5],adam:1,adapt:[1,4],adaptor:5,add:[0,1,5],added:5,adding:[0,1,3,5],addit:[0,2,3,4,5],addition:[0,4,5],addpacbio:2,address:5,adequ:4,adf1:1,adf2:1,adf:1,adjac:[1,4,5],adjust:[1,3,4,5],administr:[1,2,3],adr1:1,adr2:1,adr:1,advanc:2,advantag:[3,5],advers:4,advic:[3,5],advis:1,affect:[1,4,5],affin:5,afflict:[4,5],after:[0,1,3,4,5],agaggagagaacnggtttggaaccattc:1,against:[1,2,3,5],age:1,aggcgtctgcagccgacgcg:5,aggreg:5,aggress:3,agre:[1,5],agreement:[1,5],aim:[4,5],aka:5,alan:[1,5],algorithm:[1,3,4,5],alia:5,align:[2,4,5],alignments1:5,alignments2:5,alignments_renam:5,all:[0,1,3,4,5],allel:[1,4],allevi:5,alloc:[0,1,3],allosom:1,allow:[1,3,4,5],alon:1,along:[1,3,4,5],alongsid:5,alphanumer:1,alreadi:[1,4,5],also:[0,1,3,4,5],alt:5,altdepth:5,alter:[0,1,3,4,5],altern:[1,2,3,4,5],although:[0,1,4,5],altogeth:5,alwai:[1,3,4,5],ambigu:[1,3,4,5],amino:[1,5],amongst:4,amount:[0,4,5],amplif:4,amplifi:3,amqv00000000:1,amqv01000000:1,amqv01000002:1,amqv01000004:1,amqv01000006:1,anagaacnggaaccattcatggaaggccagagtga:1,anagaactgg_____aaccattcatggaaggccagagtga:1,anagaactggaaccattcatggaaggccagtga:1,analys:5,analysi:[0,1,2,4,5],analyt:[3,5],analyz:[3,5],anchor:5,ancillari:3,ani:[0,1,3,4,5],anim:1,ann:5,annot:[1,3,4],announc:[1,3],anomali:4,anonym:4,anoth:[0,1,4,5],ansi:0,ansicon:0,ant:1,anywher:1,apach:1,api:[2,5],appear:[1,5],append:5,appendix:[2,3,5],appl:[1,3],appli:[0,1,4,5],applic:[0,1,3,4,5],approach:[2,3,4,5],appropri:[0,1,3,4,5],approxim:[4,5],arbitrari:[4,5],arch:0,archiv:4,area:[1,3,5],arg:5,argument:[0,1,3,5],aris:[1,3,4,5],arithmet:4,arm:[1,3,5],around:[1,5],arrai:[1,5],arrang:5,artifact:5,ascend:5,ascii:[1,3,5],ask:0,assembl:[2,4],assert:5,assign:[0,1,3,5],assist:[1,2,4,5],associ:[1,3,4,5],assum:[0,1,3,4,5],assumpt:5,assur:3,ata:0,atcgtaaaataaatgca:5,atcgtaaataaaatgca:5,atgc:5,atgg:5,att:5,attach:5,attempt:[1,5],attract:5,attribut:[1,3,4,5],atttt:5,aug:4,augment:[0,5],australia:[1,5],author:[1,5],auto:[0,5],autom:3,automat:[0,1,3,4,5],autosom:[1,4,5],avail:[0,1,3,4,5],averag:[1,4,5],aview:2,avoid:[1,5],avr:[0,1,2,5],avrbuild:[2,4],avrpredict:[2,4],avrstat:[2,4],awai:[1,5],awar:[1,3,4,5],awk:[4,5],axes:5,axi:5,b06:0,b14:4,b1f96b37:1,b37:4,b472:1,b6318de1:1,b68c:1,b7baa85ebf66:0,b7ed:4,bac:1,bac_map:1,bac_reads_sdf:1,bac_ref_sdf:1,back:[1,5],background:5,backstep:1,bact:5,bact_db:5,bact_read:5,bact_sampl:5,bacteri:[2,3],bacteria:[1,4],bacteriophage_kvp40:5,bad:[1,3,4,5],bai:4,balanc:[3,4,5],bam:[2,4,5],band:5,bang:1,banner:5,bar:5,bare:1,barrier:5,base:[0,1,3,4,5],baselin:[2,3,5],baseline_sampl:5,basenam:4,bash:[1,3,5],basi:[1,3,4,5],basic:[1,3,4],bat:[0,1,3],batch:4,battel:1,bayesian:[1,3,4,5],baz:1,bdd9:1,be70:0,beagl:1,becaus:[1,3,4,5],becom:[4,5],bed:[2,3,4,5],bedgraph:[1,5],bedtool:4,been:[1,3,4,5],befor:[1,5],beforehand:5,begin:[3,5],behav:5,behavior:[0,4,5],being:[1,3,4,5],belong:1,below:[1,3,4,5],benchmark:[0,2],bergman:1,best:[1,3,4,5],better:[1,3,4,5],between:[1,3,4,5],beyond:4,bf9f:1,bgzip:[1,2,4],bherer:1,bherer_etal_sexualdimorphismrecombin:1,bia:[1,4,5],biallel:5,bias:5,bidirect:5,billion:1,bin:[1,3,5],binari:[1,3,4,5],biodefens:1,bioinformat:3,biolog:3,biologi:[1,5],biorxiv:5,bioscienc:5,biostat:1,bit:[1,3,5],blacklist:5,blade:0,blank:1,blast:[1,5],blastp:5,blastx:[3,5],block:[4,5],blosum45:5,blosum62:[3,5],blosum80:5,bnbi:1,bnd:[1,5],bndeval:2,board:0,bochet:1,bodi:3,border:5,boston:1,both:[1,3,4,5],bound:[1,3,5],boundari:[1,4,5],braithwait:[1,5],branch:5,brand:1,breadth:[1,3,4],break_out:5,breakdown:[2,5],breakend:[1,4,5],breakpoint:[1,4,5],brian:[1,5],bring:5,broad:[1,4],broadinstitut:4,broadli:5,broken:1,browser:4,bruijn:5,bubbl:5,bucket:[4,5],bui:5,build37:5,build:[0,1,2,3,5],builder:5,built:[1,3,4,5],bundl:4,busi:1,button:5,bz2:5,bzip2:[1,5],c0561a1d:1,c477b940:4,c_sampl:5,cach:0,cad2cc3c476a:1,calcul:[1,3,4,5],calibr:[1,2,3,4],call:[0,1,2,3,5],callabl:4,caller:[1,2,4,5],calls_sampl:5,came:5,can:[0,1,3,4,5],cancer:[1,2,3,5],candid:[1,5],cannot:5,cap:5,capabl:[0,1,3,4,5],capac:[2,3],captur:[4,5],card:5,care:[4,5],carri:[4,5],cat:[1,4],categor:[1,5],categori:[1,5],caus:[1,5],causal:3,caution:5,caveat:4,cbherer:1,ccaaaaataagt:1,cccccca:1,ccctcca:1,cctcctagcggtacatctccagccccttcctagna:1,cctggagg:1,ceil:5,cell:[1,5],cellular:1,center:[0,1,3],centimorgan:1,central:[0,1],ceph:[4,5],ceph_pedigre:5,certain:[1,5],certainli:5,ceu:4,ceu_trio:5,cfg:[0,1,3],cftr:1,cg1:[4,5],cg2:[4,5],cg2sdf:[2,3,4],cg_3x_readst:5,cg_map:5,cg_read:5,cg_source_fil:5,cggaggggagggcgcggagcggagg:5,cggaggggagggcgcggagcggaggggagggcgcggagcggagg:5,cgi:[1,4,5],cgmap:[2,3,4],cgmap_sample_na12878:4,cgsim:[2,3],cgt:1,chain:1,chanc:[4,5],chang:[1,3,4,5],chapter:[1,3,4,5],charact:[0,1,4,5],characterist:[1,3,4,5],charg:1,chart:[1,4,5],check:[1,2,5],checkbox:5,child:[1,4,5],children:[4,5],childsim:[1,2,3],chines:5,choic:[4,5],choos:[0,4,5],chosen:[1,4,5],chr10:[1,4,5],chr11:[1,4],chr12:[1,4],chr13:[1,4],chr14:[1,4],chr15:[1,4],chr16:[1,4],chr17:[1,4],chr18:[1,4],chr19:[1,4],chr1:[1,4,5],chr1_ki270706v1_random:4,chr1_ki270707v1_random:4,chr1_ki270708v1_random:4,chr20:[1,4],chr21:[1,4,5],chr22:[1,4],chr2:[1,4],chr3:[1,4],chr4:[1,4],chr5:[1,4],chr6:[1,4],chr7:[1,4],chr8:[1,4],chr9:[1,4],chr:[1,4,5],chrm:[1,4],chrom:5,chrominfopag:1,chromosom:[1,3,4,5],chrstat:2,chrx:[1,4,5],chry:[1,4],chunk:[1,5],cigar:[1,5],cipo:[1,5],circular:[1,4],circumst:5,citat:5,cite:1,clade:5,claim:1,clariti:1,classifi:[3,5],classpath:1,clear:[1,3,5],cleari:[1,5],cli:[2,3],click:5,clip:[1,5],clist:1,clock:[0,1,3,4],close:[1,5],closer:5,closest:[1,4,5],clu:1,cluster:[0,1,3,4,5],cm000663:4,cmb:[1,5],cmd:5,cmpk:1,cmpkasgnypallrvpgag:1,cnv:[1,2,4],cnv_s1_:4,cnv_s1_s2:4,cnvsim:5,code:[1,4,5],coeffici:1,cohort:5,coli:4,collaps:[4,5],collat:[0,5],colleagu:5,collect:[0,4,5],collis:5,color:[2,5],column:[1,3,4],com:[1,3,4,5],combin:[1,3,4],come:[3,5],comma:[0,1,5],command:[2,4],commandlin:0,commenc:5,comment:[1,4,5],commerci:[0,3],common:[1,3,4],commonli:[0,5],commun:[3,4,5],comp_out:5,compar:[3,4],comparison:[0,1,3,4],compat:5,compens:5,complement:[1,5],complet:[1,3,4,5],complete_genom:5,complete_genomics_2:5,completegenom:[1,4,5],complex:[1,2,4,5],complianc:1,complic:5,compon:[1,3,4,5],composit:[2,3],comprehens:[1,3,5],compress:[0,3,4,5],compris:[1,3,4,5],comput:[0,2,3,4,5],computation:[4,5],con:4,concaten:5,concept:5,conceptu:[3,5],concern:5,conclus:5,concord:5,condit:[0,1,4,5],conemu:0,confid:[1,3,5],confidenti:0,configur:[1,2,3,4,5],conjunct:[4,5],connect:[1,5],consensu:3,consequ:5,consequenti:1,conserv:5,consid:[1,4,5],consider:[4,5],consist:[0,1,3,5],consol:[0,5],constant:1,constitu:5,constitut:4,constrain:5,constraint:[1,3,5],construct:[1,3,4],consult:[1,5],consum:5,consumpt:5,contact:[1,3,4,5],contain:[0,1,3,4,5],contamin:[2,5],content:[0,5],context:[1,5],contig:[1,4,5],contigu:5,continu:1,contract:1,contrari:[1,5],contrast:5,contribut:[1,5],contributor:1,control:[0,3,5],convei:1,conveni:[1,4,5],convent:[1,5],convers:[1,3,4,5],convert:[1,3,4,5],convex:5,coordin:[1,4,5],cope:4,copi:[0,1,2,5],copyright:1,core:[0,1,3,5],correct:[1,3,4,5],correctli:[4,5],correspond:[1,4,5],cosm3805:1,cosmic:[4,5],cost:[1,3,5],could:[1,4,5],count:[1,4,5],countermeasur:1,coupl:5,cours:4,cov_sample_na12878:4,cover:[1,3,4,5],coverag:[0,2],coverage_level:1,coveragetsv:5,cpu:[0,3,5],cram:5,crash:0,creat:[0,1,2,5],creation:[1,4,5],credit:5,criteria:[1,5],criterion:5,crop:3,cross:[3,4,5],crossov:[1,5],ctcatggaga:1,ctt:5,cttaaac:1,cttaac:1,cttt:5,cumul:[1,4],curat:5,current:[0,1,3,4,5],custom:[0,1,3,4,5],customis:5,customiz:3,cut:5,cutoff:[4,5],cyanobacteria:1,d74f45d:0,d_sampl:5,damag:1,dash:5,data:[0,1,2],databas:[1,2,3,5],dataset:[0,1,5],date:[0,1,4,5],daughter:[3,4,5],davi:5,david:[1,5],dbsnp:[4,5],dcoc:[1,5],dcof:[1,5],ddr3:3,deal:[1,4,5],debug:3,decid:[1,5],decim:5,decis:[0,1,5],declar:[1,5],decod:5,decoi:[1,4],decompos:5,decompress:[1,4,5],decreas:[3,4,5],dedic:1,deep:3,deeper:[3,4],def:1,defin:[0,1,3,4,5],definit:[1,5],degre:[4,5],del:5,delet:[1,3,4,5],delimit:[1,5],delin:3,deliv:[1,3,5],delta:[1,5],demand:[0,1,3],demo:1,demonstr:[0,4,5],denot:[1,4,5],denovo:5,denovosim:[2,3],dens:[4,5],densiti:5,depart:[1,5],depend:[0,1,3,4,5],deploy:[0,1,2,5],depth:[1,3,4,5],deriv:[1,3,4,5],descend:[1,5],describ:[0,1,3,4,5],descript:[0,2,4,5],design:[1,3,5],desir:[0,1,3,4,5],destin:[0,5],detail:[1,3,4,5],detect:[0,1,2],determin:[0,1,3,4,5],determinist:5,develop:[1,3,4,5],deviat:[1,5],dh10b:4,diagram:5,dictionari:1,did:[3,4,5],didn:5,differ:[0,1,3,4,5],difficult:5,difficulti:5,dimension:[1,4,5],diploid:[1,3,4,5],dir:[3,5],dir_map:5,direct:[1,5],directli:[0,1,3,4,5],directori:[0,2,3,4,5],disabl:[0,5],disagre:1,disambigu:5,discard:[1,3,4,5],disclaim:1,disconnect:5,discord:2,discord_pair:1,discord_sample_na12878:4,discordantli:[1,4,5],discov:[1,4],discrep:5,discuss:[1,3,5],diseas:3,disk:[0,3,4,5],displai:[0,1,3,4,5],distanc:[1,3,5],distinct:[1,4],distribut:[2,3,4],divers:[1,3],diversity_index:1,divid:[0,1,5],dna:[1,2,3,5],dnp:[1,5],document:[0,1,4,5],doe:[1,3,4,5],doesn:5,doi:[1,5],doing:[1,4],dokladi:1,domin:5,don:[4,5],done:[1,4,5],dot:[4,5],doubl:[1,5],doubt:5,down:5,download:[1,4,5],downstream:[3,4,5],dpr:[1,4],drag:5,dramat:[1,5],draw:5,drawn:5,drive:0,drop:[4,5],drtg:0,dual:3,due:[1,3,4,5],dump:[1,5],duo:0,dup:[1,5],duplic:[1,4,5],dure:[0,1,3,4,5],duster:5,dynam:[1,5],e9e7:4,each:[0,1,3,4,5],eap2:1,earlier:[1,5],eas:[3,5],easi:[3,5],easier:[1,3,4,5],easili:[1,4,5],ebi:4,echo:1,ecoli:4,ecolog:1,edb9:1,edg:1,edit:[0,1,3,5],editor:4,edu:1,effect:[1,4,5],effici:[1,3,4,5],effort:1,either:[1,3,4,5],elaps:5,elimin:3,ell:5,els:5,elsewher:4,email:3,embark:5,embed:0,emploi:[1,3,4,5],empti:[0,5],enabl:[0,1,3,4,5],encapsul:1,encod:[1,5],encompass:5,encount:[0,1,3,5],end:[1,3,4],endors:1,engin:[4,5],enhanc:[0,3],enough:5,ensur:[1,3,4,5],ensureformathead:5,enter:[1,3,5],enterpris:3,entir:[1,3,4,5],entireti:5,entri:[1,5],env:[1,3],environ:[0,1,3,5],equal:[1,3,4,5],equilibrium:[1,5],equival:[1,3,4,5],ergonom:3,erron:3,error:[3,4,5],escherichia:4,escherichia_coli_k_12_substr__dh10b_uid58979:4,especi:[3,5],essenti:[1,5],establish:[1,3],estim:[0,1,2,3,5],etc:[1,3,4,5],european:4,eval:5,evalu:[1,2,3],even:[1,5],event:[1,5],everi:[0,1,3,4,5],evid:[1,3,5],evolv:1,exac:5,exact:[1,3,5],exactli:[1,4,5],examin:[3,4,5],exampl:[0,1,3,4],exce:[0,1,5],exceed:[1,5],excel:[3,4],except:[1,2,4,5],excerpt:1,excess:[4,5],exclud:[4,5],exclus:[1,5],execut:[0,1,3,4,5],exemplari:1,exist:[1,4,5],exit:1,exom:[1,4,5],expect:[0,1,3,4,5],expens:[3,5],experi:[3,4,5],experiment:4,expir:5,explan:[3,5],explicit:[4,5],explicitli:[0,1,4,5],explor:5,expr:1,express:1,extend:[1,3,5],extens:[0,2,3,4,5],extern:[4,5],extra:[0,1,4,5],extract:[2,4],extrem:[1,5],f1_g_s_1m:1,f1_n_an_1m:1,f1_o_bm_1m:1,f1_o_sp_1m:1,f1_o_td_1m:1,f1_v_pf_1m:1,f8968de308e3:4,f_sampl:5,facil:4,facilit:5,factor:[1,5],fail:[0,1,4,5],fail_val:1,failur:5,fairer:5,fairli:1,fall:[1,5],fals:[0,4,5],falsi:5,fam01:1,fam:[1,4,5],famili:[1,2,3],familiar:[3,5],family1:5,family_sim:5,farther:5,fashion:4,fast:[3,4,5],fasta:[3,4,5],faster:[0,4,5],fastq:[3,4,5],fastqtrim:2,fatal:0,father:[1,3,4,5],father_gt:5,favor:1,fb3b:1,fb8b6b34c5d0:1,featur:[0,1,3,4,5],feb:4,fed:5,feder:1,feedback:0,femal:[1,4,5],few:[1,4,5],fewer:[4,5],field:[0,2,3,4,5],fifth:1,figur:0,file:[2,5],filed:1,fileformat:1,filenam:5,fill:[4,5],filter:2,filtered_sample_na12878:4,find:[1,2,3,5],fine:[0,1,5],finish:[0,4],firefox:4,firmicut:5,first:[0,1,3,4,5],firstli:5,fit:[1,3],five:[1,5],fix:[3,5],flag:[0,1,3,4,5],flatten:1,flexibl:[3,5],flip:5,floor:[1,5],flow:5,fn_ca:5,fna:4,focu:4,focus:[3,5],fold:[1,4,5],follow:[0,1,3,4,5],forc:5,foreach:5,form:[0,1,3,4,5],format:[0,2],former:5,formerli:1,formula:[1,5],fortun:1,forum:[1,3],forward:[1,5],found:[1,4,5],foundat:1,founder:[4,5],four:[1,3],fourth:4,fp_ca:5,frac:5,fraction:[1,3,4,5],fragment:[1,5],frame:1,francisco:[1,5],franklin:1,free:[0,1,3],freememori:0,freq:5,frequenc:[2,3,5],frequent:[1,5],from:[0,1,3,4,5],front:5,ftp:[4,5],full:[0,1,3,4,5],fulli:[1,4,5],fund:1,furnish:1,further:[0,1,3,4,5],g1_samp:5,ga4gh:5,gaastra:[1,5],gac:1,gactctctgacgctgcncgtacgtgccaaaaataagt:1,gagtgctgcaggccgaccagcaactcatggagaagaccaagg:1,gain:5,gap:[2,3,4,5],gca:4,gca_000001405:4,gcc:1,gcg:1,gcgcgcgcgcg:5,gena:1,genb:1,gender:1,gene:5,gener:[0,1,2,3,5],genet:[2,3,5],genetic_map:1,genom:[0,1,2,3,5],genome_ref:5,genomesim:[2,3],genometest:5,genotyp:[1,4,5],genu:5,genuin:5,germlin:[1,4,5],get:[1,5],ggaaggagtgctgcaggccgaccctcatggaga:1,ggaaggggagtgctgcaggccgacc:1,ggaaggggagtgctgcaggccgaccctcatggaga:1,ggi:4,ghz:0,gigabyt:0,github:[1,3,4,5],give:[0,3,4,5],given:[1,3,4,5],glob:5,global:[1,3,5],gnu:1,gnuplot:3,gold:5,goldstandard:5,good:[1,3,4,5],googl:[1,3],gov:[4,5],govern:[1,5],gqd:[1,4,5],gradient:5,grain:5,grant:1,granular:5,graph:4,graphic:[1,3,5],graphviz:[4,5],grch38:4,greater:[1,3,5],greatli:5,grep:5,gridhost:0,gross:5,ground:5,group:[0,2,3,5],gs002290:4,gs00290:4,gsapubftp:4,gsr:1,gsrt:1,gsrtfgi:1,gtct:5,guarante:[3,4,5],guest:5,guid:[1,3],guidelin:3,gunzip:5,gut:4,gzip:[1,5],gzipfix:1,gzipinputstream:1,h1_base:5,h1_cnv:5,h1_coverag:5,h1_read:5,h1_sample_left:5,h1_sample_right:5,h1_test:5,had:[1,5],hair:5,half:[1,3,5],hand:[4,5],handl:[0,1,3,4,5],hap:5,haploid:[1,2,3,5],haplotyp:[4,5],hapmap:2,hapmap_3:4,happen:5,hard:5,hardi:[1,5],hardwar:[0,5],harvard:1,has:[0,1,3,4],hash:5,hashdist:2,hashmap:5,have:[0,1,3,4,5],haven:5,head:4,header:[2,4,5],held:1,help:[1,2,3,4],helper:1,here:[0,3,4,5],herebi:1,herein:1,het:[1,5],heterogen:5,heterozyg:[1,3,5],heterozygos:[1,5],hg18:1,hg19:[1,4,5],hgsid:1,hgtrack:1,hide:5,hierarch:1,high:[0,1,3,4,5],higher:[1,3,4,5],highest:[4,5],highli:[0,3,5],highlight:[2,5],hilbush:[1,5],histogram:[3,5],hit:[1,3,4,5],hold:[0,1,4,5],holder:1,hom:[1,5],home:5,homeland:1,homolog:[3,4],homopolym:[1,5],homozyg:[1,3,5],hope:1,host0:1,host1:1,host:[0,1,3,4],hostnam:[0,1,3],hotspot:5,hour:4,how:[1,3,4,5],howev:[0,1,3,4,5],hs37d5:4,hs38d1:4,hs_map:5,hs_refer:5,hs_snp:5,hshqdc:1,hslo:1,hst1:1,html5:[1,4,5],html:[1,3,4,5],hts:[1,3,4],htsjdk:1,http:[0,1,3,4,5],hull:5,human:[0,1,2,3,5],human_protein_read:5,human_reads_sdf:[1,5],human_ref:5,human_ref_sdf:[1,5],human_refer:[4,5],humanfasta_return:5,humanfastq_return:5,humanmapping8:1,humansdf:5,hyper:1,hypercomplex:1,hypothes:[1,4],hypothesi:[1,4,5],i_22:5,i_7:5,idea:[1,4,5],ideal:4,ident:[1,3,4,5],identif:[1,3,5],identifi:[1,3,4,5],ids:[4,5],ign:5,ignor:[1,4,5],igv:5,illumina1:5,illumina:[1,3,4,5],illumina_p:5,illumina_read:5,illumina_s:5,illumina_sdf:5,illustr:5,imag:[4,5],imagemagick:5,imbal:1,immedi:5,immut:1,impact:[0,5],imping:5,implement:3,impli:[1,5],imprecis:1,improv:[0,3,4,5],impur:5,imput:[1,5],inaccur:5,inadequ:4,inappropri:5,inbreed:1,inc:[1,3,5],incident:1,includ:[0,1,3,4,5],inclus:[1,5],incom:5,inconsist:[1,4,5],incorpor:[4,5],incorrect:[4,5],incorrectli:[1,4,5],increas:[1,3,4,5],increment:5,incur:[1,5],ind:[1,4,5],indel:[1,2,4],independ:[0,1,3,4,5],index:[0,2,3,4],indic:[0,1,3,4,5],indirect:1,individu:[1,3,4,5],industri:[3,5],inexactli:5,infer:4,info:[4,5],inform:[0,2,3,5],ingli:[1,5],inherit:[1,3,4,5],initi:[1,3,4,5],initial_assembl:5,inner:1,innov:3,input:[0,2,4,5],input_readgroup_id:5,ins_1:5,ins_a:5,insert:[1,3,4,5],insid:[1,5],insight:5,inspect:[3,4,5],instal:[1,2,5],instanc:[4,5],instead:[0,1,3,4,5],institut:[0,1,4],instruct:[1,2,4,5],insuffici:4,integ:[1,5],integr:[3,5],intel:[0,3],intend:[1,3,5],intens:[1,5],interact:[1,3,4],interest:[1,4,5],interfac:[2,3],interleav:5,intermedi:5,intern:[0,1,3,4,5],internet:0,interpol:5,interpret:[1,3,5],interrupt:1,intersect:[1,3,4,5],interv:[1,4,5],introduc:[1,3,4,5],introduct:[2,5],inv:5,invers:[1,5],inverse_simpson_index:1,invert:5,investig:[0,3,4,5],invok:[4,5],involv:[4,5],ion:[1,2,5],iont:1,iontorr:[1,4,5],irrelev:5,irrespect:5,irvin:[1,5],isn:5,issu:[3,4,5],iter:3,its:[1,3,4,5],itself:[1,5],iupac:4,jackson:[1,5],jar:[0,1,3],java:[0,1,3,5],javascript:2,jivesoftwar:4,job:[0,1,3,4,5],john:[1,5],join:[1,5],joint:[1,3,4,5],jointli:[4,5],journal:[1,5],jre:[1,3],june:[1,5],just:[0,4],justin:5,jvm:[0,3,5],keep:[1,4],kei:[3,5],kept:[4,5],kind:[1,4,5],kmer:5,know:[4,5],knowledg:[1,5],known:[1,3,4,5],krona:1,kurt:[1,5],kvp40_sample1:5,kvp40_sample2:5,label:[1,3,5],lack:5,lal:[1,4,5],lambda:1,lane:[1,4],lane_id:4,languag:1,laptop:[0,3],larg:[0,1,3,4,5],larger:[4,5],largest:[4,5],last:[1,4,5],later:[0,1,4,5],latter:[4,5],launch:5,law:1,layout:5,lead:[1,3,4,5],leaf:5,learn:[4,5],least:[1,3,4,5],leav:[0,4],left:[1,3,4,5],left_fq:4,legaci:5,len:[1,5],length:[0,1,3,4,5],lenient:5,leq:1,less:[1,3,4,5],let:5,level:[0,1,3,4,5],levenshtein:1,leverag:3,liabil:1,liabl:1,librari:[1,5],licens:[0,1,2],lies:5,life:1,lifetech:4,lift:4,ligat:5,lightweight:5,like:[1,3,4,5],likelihood:[1,3,5],limit:[0,1,3,4,5],lin:[1,5],line:[1,2,3,4],lineag:[1,2],linear:[1,4,5],link:5,linkag:[1,5],linux:[1,3],list:[0,1,3,4,5],listen:[0,5],liter:[1,5],littin:[1,5],littl:[0,1],llc:1,load:[1,3,4,5],local:[0,1,5],locat:[1,3,4,5],loci:[3,5],log10:1,log:[2,3,4,5],log_10:1,logic:5,loh:[1,4,5],longer:[3,5],longest:1,look:[1,4,5],lookup:[2,5],loop:[1,4],loss:[1,5],lot:[4,5],low:[1,3,4,5],lower:[1,3,4,5],ls454:[1,4,5],ls454_pe:5,ls454_se:5,m_sampl:5,mac:0,macbook:0,machin:[1,2,3,4,5],maco:[1,3],made:[1,3,4,5],mai:[0,1,3,4,5],main:[4,5],mainindex:3,maintain:3,maize_chr:5,maize_refer:5,major:0,make:[0,1,3,4,5],malakshah:[1,5],male:[1,4,5],mammalian:4,manag:[1,2,5],mandat:5,mani:[0,1,3,4,5],manipul:[1,5],manner:[1,4],manual:[0,1,3,4,5],manufactur:5,map:[0,2],map_out:5,map_popul:4,map_rs:5,map_sample1:4,map_sample_na12878:4,map_temp_sample1:4,map_trio:4,mapf:[2,3,4],mapp:[2,3,4],mapper:5,mapq:[1,5],mapx1:5,mapx2:5,mapx:[2,3,4],mapx_out:5,mapx_result:4,mapxrenam:2,mar:4,mark:[4,5],marker:3,markup:0,mask:[4,5],mat:[1,4,5],match:[1,3,4],mate:[1,3,4,5],materi:[1,4,5],matern:[1,5],math:5,matric:1,matrix:[1,3,4,5],matter:4,max:[1,3,4,5],maxaltdepth:5,maxdel:5,maxim:[3,5],maximis:5,maximum:[0,1,4,5],maxin:5,maxscor:1,mcp:5,mcu:5,mcv:5,mean:[1,4,5],meaning:[1,5],meaningfulli:5,meaningless:5,meanqad:[1,5],meant:3,measur:[4,5],mechan:[0,3,5],med_qual:5,medic:3,medicin:3,meet:[0,1,5],mehul:[1,5],member:[3,4,5],memori:[0,1,3,4,5],mendelian:[1,2,4],menu:5,mer:[1,3,4,5],merchant:1,merg:[1,4],messag:[1,3,4,5],met:[1,4],meta:[2,3],metabol:3,metadata:[3,4,5],metagenom:[0,1,2],method:[0,1,5],metric:[1,5],mgh:1,microbi:[1,3],microsoft:[3,4],midpoint:5,might:[1,3,4,5],million:[1,4],min:[1,4,5],minim:[3,4,5],minimum:[0,1,4,5],minor:1,mis:5,mislabel:5,mismatch:[1,3,5],miss:[1,4,5],mit:1,mitochondria:1,mix:[3,5],mixtur:[1,3],mkdir:4,mnp:[1,3,4,5],mode:[2,3],model:[0,1,2,3,5],modif:[2,3,5],modifi:[1,3,4,5],modul:[0,1],molecular:1,monitor:3,month:0,more:[0,1,3,4,5],mosaic:5,most:[1,3,4,5],mostli:3,mother:[1,3,4,5],mother_gt:5,mount:0,move:[4,5],ms_8399:4,ms_auto_b14:4,much:[3,4,5],multi:[1,2,3,4,5],multiallel:5,multipl:[1,2,3,4,5],multipli:5,must:[0,1,3,4,5],mutat:[1,3,5],mylan:0,mypedigre:5,mysamrg:1,mysdf:5,n_sampl:5,na12877:[1,4],na12878:[1,4,5],na12878_gs002290:4,na12878_l001:4,na12878_l001_1:4,na12878_l001_2:4,na12878_map:5,na12878model:4,na12878trio:4,na12879:4,na12880:4,na12881:4,na12882:4,na12883:4,na12884:4,na12885:4,na12886:4,na12887:4,na12888:4,na12889:[4,5],na12890:[4,5],na12891:[4,5],na12892:[4,5],na12893:4,na19238:1,na19239:1,na19240:[1,4,5],na24143:5,na24149:5,na24385:5,na24631:5,na24694:5,na24695:5,naa:[1,5],name:[0,1,2,3,5],namedata0:3,nameindex0:3,namepointer0:3,namespac:5,nation:1,nativ:4,natur:[1,4,5],nbacc:1,nc_010473:4,ncbi2tax:[1,2],ncbi:[1,4,5],ncbitaxdir:5,nearbi:5,nearest:[3,4,5],necessari:[1,4,5],necessarili:[1,5],need:[0,1,3,4,5],needleman:1,neg:[4,5],negat:1,neglig:1,neighbor:[3,4,5],neither:[1,5],neq:5,net:[0,1],network:[0,4,5],new_human:4,new_human_snp:4,newer:[0,5],newick:[1,3,4],newick_format:1,newli:5,next:[4,5],ngsparam:0,nichola:1,nicngsrtfgilcipkkpgkypallrvpgagvr:1,nih:[4,5],nirqgsrtfgi:1,nirqgsrtfgifcmpkasgnypallrvpgaggr:1,nirqgsrtfgilcmpkasgnypallrvpgagvr:1,nlm:[4,5],node:[0,1,3,4,5],nohzadeh:[1,5],nois:5,nomenclatur:3,non:[0,1,3,4,5],non_snp_roc:5,none:[0,1,4,5],noninfring:1,nonneg:5,nonspecif:1,nor:1,norank:5,normal:[1,2,3,5],normal_:4,normal_map_:4,normal_reads_:4,normalis:5,note:[0,1,4,5],notic:[2,4],notif:0,notion:1,novel:[1,3,4,5],novo:[1,3,5],now:[0,1,4,5],nref:1,nuccor:4,nuclear:5,nucleotid:[1,3,4,5],num:5,number:[0,1,2,5],numer:[1,5],nvrpgsrtygilcmpkkegkypallrvpgagir:1,object:[1,3,4,5],observ:[1,4,5],obtain:[1,4,5],obviat:5,obviou:5,obvious:1,occasion:[1,5],occupi:5,occur:[1,3,4,5],ococ:[1,5],ocof:[1,5],oct:4,off:[1,4,5],offic:3,offspr:4,often:5,old:5,omit:[1,4,5],omni:[4,5],onc:[1,4,5],ondov:1,one:[0,1,3,4,5],ones:[4,5],onli:[0,1,3,4],onlin:[1,3,5],onto:5,open:[1,3,5],openjdk:1,oper:[0,1,3,5],oppos:4,opt:0,optic:5,optim:[1,2,5],option:[0,1,2,3,5],oracl:1,order:[1,3,4,5],ordinari:5,ordinarili:5,org:[1,4,5],organ:[0,1,3,5],orient:[1,4,5],origin:[1,3,4,5],orl:5,orp:5,other:[0,1,3,4,5],otherwis:[0,1,4,5],our:[1,3,4,5],out:[1,4,5],output:[0,2,4],output_readgroup_id:5,outset:5,outsid:[1,4,5],over:[1,3,4,5],overal:[3,4,5],overlai:5,overlap:[1,4,5],overrid:[1,3,5],overridden:[1,3],overview:[2,4],overwrit:5,own:[0,1,4,5],owner:1,ownership:3,pac_bio:5,pacbio:[1,5],pacif:5,packag:[3,5],pad:5,pai:0,pair:[1,3,4],pairwis:5,pane:5,par1:1,par2:1,par:[1,4],parallel:[0,2,4,5],paramet:[0,1,3,4,5],parent:[1,4,5],parentag:5,parid:1,parkwai:1,pars:4,parseint:5,part:[1,4,5],parti:[1,4,5],partial:5,particular:[1,3,4,5],particularli:[4,5],partit:[4,5],partition1:4,partition2:4,partition3:4,pass:[1,5],past:[1,5],pat:[1,4,5],patent:[1,3,5],patern:[1,5],path:[0,1,4,5],pathwai:3,patient:4,pattern:4,pca:[1,4],pcr:5,pdf:[1,3,4,5],ped:[2,3,4,5],ped_vcf_head:5,pedfilt:[1,2],pedigre:[2,5],pedsamplesim:[1,2],pedstat:[1,2,4],peel:5,penal:5,penalti:[1,5],pend:[1,5],per:[0,1,3,4,5],percent:[1,5],percentag:[1,3,5],perform:[1,2,3],perl:5,perman:5,permiss:[0,1,5],permit:[1,3,4,5],person1:5,person2:5,person3:5,person:[1,3],persona:5,personb:5,pertain:4,petrim:2,pf3:5,pflow:0,pfread:0,pftemplat:0,pgm:4,phase2_reference_assembly_sequ:4,phase:[1,3,4,5],phen:[1,4,5],phenotyp:[1,5],phillippi:1,phred:[1,5],phylogenet:[1,5],phyloxml:[1,3,4],phylum:[1,5],physic:1,pick:5,pie:[1,4,5],piec:3,pielou:1,pileup:[3,5],pipelin:[0,1,2,4],place:[1,3,4,5],placement:[3,5],plan:[1,2,3,4],plant:[1,3],plasmid:1,platform:[1,3,4,5],platinum:4,platinumgenom:4,plausibl:5,pleas:[1,3,5],plink:1,ploidi:[1,4],plot:[1,3,4,5],plu:[1,3,5],pnext:[1,5],png:[4,5],pngu:1,point:[1,4,5],poisson:5,polymorph:[1,3,5],polymutt2:1,polyploid:[1,4],poor:[1,3,4,5],pop:5,pop_vari:4,popsim:[2,3],popul:[1,2,3],popular:5,population_prior:4,popvar:5,port:[0,5],portabl:[4,5],portion:1,pos:[1,4,5],posit:[1,3,4],possess:4,possibl:[0,1,4,5],post:[1,3,5],posterior:[1,3,5],potenti:[1,4,5],power:5,ppb:1,practic:[1,4,5],pragmat:5,pre:[1,4,5],prebuilt:4,preced:1,precis:1,predict:[1,3,4,5],predictor:5,prefer:[3,4,5],prefix:5,prepar:[0,1,2,3,5],preprocess:5,prerequisit:4,presenc:[3,4,5],present:[1,3,4,5],preserv:5,preset:5,presum:5,prevent:[1,4,5],previou:[1,4,5],previous:5,primari:[4,5],primarili:[1,4,5],princip:[1,3,4,5],principl:5,print:[4,5],prior:[1,2,3],prioriti:5,privileg:[0,1,3],pro:4,probabl:[1,3,4,5],probe:5,problem:[0,1,5],problemat:5,procedur:[4,5],proceed:1,process:[0,2,4,5],processor:[0,1,3,5],procur:1,produc:[1,2,3,5],product:[0,1,2,3,5],profit:1,program:[1,3,4,5],progress:[0,2,3,5],project:[1,4,5],promot:1,prompt:[1,3,5],proper:[1,5],properli:1,properti:[0,1,5],proport:[1,4,5],proprietari:1,protein:[1,2],protein_db:5,proteobacteria:5,prototyp:1,prove:4,provid:[0,1,3,4,5],proxi:0,prune:5,pseudo:1,pseudoautosom:[1,4],pub:5,publish:1,pur:1,purcel:1,purchas:3,pure:5,puriti:1,purpos:[1,3,4,5],push:[1,5],put:[1,3,4,5],qname:[1,5],quad:3,qual:[4,5],qualiti:[0,1,3,4],qualti:5,quantiti:4,quarantin:[1,3],queri:[1,3,5],query_seq:5,querylength:1,question:[1,3,5],quick:[1,2,5],quickli:4,quit:5,quot:1,r121336:4,r_2011_07_19_20_05_38_user_b14:4,rack:[0,3],rais:[4,5],ram:[0,1,3,4,5],random:[4,5],randomli:5,rang:[1,3,4,5],rank:[1,5],ranknam:1,rapid:3,rate:[1,3,5],rather:[1,3,4,5],rathod:[1,5],ratio:[1,3,4,5],raw:[1,4,5],rce:1,rcequiv:1,rdefault:5,reach:[1,5],read:[0,2],read_data:1,readabl:[3,5],readcount:5,readgroup1:5,readgroup:[1,5],readi:[4,5],readm:[2,3],reads_1:4,reads_2:4,reads_sd:5,reads_shuffl:5,readsim:[2,3],readsimev:2,real:[0,1,3,4,5],realign:1,realist:0,realiti:4,realli:5,realtimegenom:[1,3,4,5],reason:[1,4,5],recal:[4,5],recalibr:[4,5],receiv:[1,4,5],receiver_operating_characterist:5,recip:4,recogn:[4,5],recombin:5,recommend:[1,3,4,5],recomput:1,reconstruct:1,record:[0,2,3,4],redirect:5,redistribut:1,reduc:[1,3,4,5],reduct:[1,5],redund:[4,5],redwood:1,ref:[4,5],refer:[0,2,3],referenc:1,refin:5,reflect:[1,5],refseq:4,regard:[1,3,4,5],regardless:[1,5],regener:5,region:[2,3,4],regist:1,registr:4,regular:5,reject:5,rel:[1,4,5],relabel:[1,5],relat:[1,3,4,5],related:4,relationship:[1,2,4,5],relax:5,releas:[1,3,5],relev:[4,5],reli:5,reliabl:[3,5],remain:[1,5],remap:4,remot:1,remov:[1,3,4,5],renam:[4,5],reorder:5,repeat:[1,4,5],repetit:5,replac:[1,4,5],replic:5,report:[0,1,2,3,5],repres:[1,3,4,5],represent:[1,4,5],reproduc:1,request:0,requir:[0,1,3,4,5],requisit:5,rerun:[4,5],rescor:[1,4],research:[1,3,4,5],reserv:1,reset:5,resid:[4,5],residu:[1,4,5],resolut:5,resolv:5,resourc:4,respect:[1,3,4],restor:5,restrict:[1,3,4,5],result:[0,2,3,4,5],retain:[1,4,5],retriev:[1,3,5],reus:4,reusabl:4,revers:[1,5],review:[2,3],rg1:5,rgstat:[1,4,5],richard:[1,5],right:[1,3,4,5],right_fq:4,rightarrow:5,rname:1,rnext:[1,5],roch:1,rocplot:2,root:[1,3,4,5],ross:[1,5],rough:5,roughli:5,row:4,rpb:[1,4],rpm:[0,3],rs23987382:1,rsh:1,rtg:[0,2],rtg_default_thread:0,rtg_jar:0,rtg_java:0,rtg_java_opt:0,rtg_mem:[0,1,3,5],rtg_models_dir:0,rtg_proxi:0,rtg_references_dir:[0,5],rtg_talk_back:0,rtg_talkback:0,rtg_taxonomi:5,rtg_usag:0,rtg_usage_dir:0,rtg_usage_host:0,rtg_usage_opt:0,rtgcustom:5,rtgv2:1,rule:0,run:[1,2,3,5],runtim:[0,1],s12_r1:5,s12_r2:5,s12_trim:5,s12_trimmed_r1:5,s_sampl:5,sahar:[1,5],sai:5,sam2bam:2,sam:[2,4,5],same:[0,1,3,4],samfil:5,sammerg:2,sampl:[0,2],sample1:[4,5],sample1_1:4,sample2:4,sample2_2:4,sample3:4,sample4:4,sample5:4,sample_1:4,sample_2:4,sample_id:4,sample_na12878:4,sample_nam:5,sampleread:5,samplereadssdf:5,samplereplai:[2,3],samplesim:[2,3],samrenam:[1,2,3],samstat:[2,4],samtool:[1,3,4,5],samv1:[1,3],sanger:[4,5],sars_coronaviru:5,sars_sample1:5,sars_sample2:5,satisfi:1,save:[0,1,5],sbp:[1,4],scale:[0,1,3,5],scan:[3,5],scenario:[3,4,5],scheme:5,scienc:1,scont:5,score:[0,2,3,5],screen:[1,4,5],script:[0,1,3,4],sdf2cg:2,sdf2fasta:[2,3],sdf2fastq:[2,3],sdf2sam:2,sdf:[1,3,4,5],sdf_proteinref:5,sdf_read:5,sdfsplit:[2,3],sdfstat:[1,2,4],sdfsubseq:2,sdfsubset:2,sean:[1,5],search:[1,2],search_out:5,second:[0,1,3,4,5],secondari:5,secondli:5,section:[1,3,4,5],secur:1,see:[1,3,4,5],seed:5,seem:1,seen:5,segment:[1,3,4,5],segreg:4,select:[1,3,4,5],self:3,sell:1,semant:[1,4,5],semi:[1,3,5],semicolon:1,send:0,sens:[1,5],sensit:[0,2,4],sensitivity_and_specif:5,sent:0,sep:4,separ:[0,1,3,4,5],seq:[1,4],seqdata0:3,seqpointer0:3,seqs_for_alignment_pipelin:4,sequenc:[1,2,5],sequence_nam:5,sequenceindex0:3,seri:[3,5],serial:0,server:[0,1,3,4,5],servic:[1,5],session:5,set:[0,1,2,3,5],setup:5,sever:[0,1,3,4,5],sex:[1,2,3,5],shall:1,shannon:1,shannon_index:1,shape:1,share:[0,1,5],shell:[1,4,5],shift:[1,5],shore:1,shorter:[3,5],should:[1,4,5],show:[1,3,4,5],shown:[1,3,4,5],shtml:1,shuffl:5,side:[1,5],sidepan:5,sign:4,signal:[1,5],signific:[3,5],significantli:3,sim:5,sim_read:5,simil_out:5,similar:[2,3],similarli:[3,4,5],simpl:[0,1,3,4],simpli:[4,5],simpson:1,simul:[1,2,3],simulatedsequence1:1,simulatedsequencen:5,simultan:[1,4,5],sinc:[1,4,5],singapor:[1,5],singl:[1,2,3,5],site:[1,2,3,5],situat:[1,3,4,5],six:[1,3],size:[0,1,3,4,5],skew:5,skip:[1,5],slice:5,slider:5,slightli:[1,5],slow:[4,5],sm_base:1,sm_father:1,sm_mother:1,sm_normal:4,sm_son:1,sm_tumor:[1,4],small:[2,3,4,5],smaller:[0,1,3,4,5],smith:1,smooth:[1,3,4,5],snp1:5,snp2:5,snp:[1,2,4],snp_chr5:5,snp_roc:5,snp_sample_na12878:4,snp_sample_na12878_chr:4,snp_sample_na12891:4,snps_biallel:5,snps_cov5:5,soft:[1,5],softwar:[0,1,2,4,5],solari:3,sole:5,solexa:[1,4,5],solut:[3,5],som:5,somat:[1,2],somatic_out:4,some:[0,1,3,4,5],someth:5,sometim:[3,5],somewhat:[4,5],somewher:5,son:[3,4,5],son_gt:5,sort:[1,3,4,5],sourc:[1,3,4,5],sourceforg:1,soviet:1,sp_out:5,space:[1,3,4,5],span:5,spars:5,speak:5,spec:[1,3,4],speci:[2,3],special:[1,4,5],specialist:3,species_even:1,species_genom:5,species_result:4,specif:[0,1,2,3,5],specifi:[0,1,3,4,5],speed:[0,3,5],sph:1,split:[1,4],split_read:5,spot:5,spotti:4,spread:5,spreadsheet:[3,4,5],spuriou:5,sqrt:5,squar:5,srr002978:1,srr005490:5,ssc:[1,4,5],stage:[1,4,5],stand:1,standard:[0,1,2,4,5],start:[0,1,2,4,5],startup:5,stat:[1,5],statist:[1,2,3,5],statu:[0,1,4,5],stdin:5,stdout:5,step:[1,3,4,5],still:[1,4,5],storag:[0,3],store:[0,1,3,4,5],straight:[1,5],strain:[3,4,5],strain_map:5,strain_read:5,strain_ref:5,strand:[1,4],strategi:[4,5],streamlin:4,strength:[1,4,5],stretch:5,strict:[1,5],stricter:5,strictli:5,string:5,stringenc:5,strl:1,strong:[1,5],strongli:4,stru:1,structur:[1,2,3,5],stuart:[1,5],studi:5,sub:[4,5],subclass:5,subdirectori:[1,4,5],subfamili:5,subgenu:5,subgroup:5,subject:[1,3,5],sublicens:1,submiss:0,submit:0,subord:5,subphylum:5,subsampl:5,subscrib:1,subsequ:[1,3,4,5],subset:[3,5],subset_read:5,subspeci:5,substanti:1,substitut:[1,3,4,5],subtleti:5,subtli:5,subtre:5,succeed:0,success:[1,3,5],successfulli:[3,5],suffic:1,suffici:[1,4,5],suffix:0,suggest:[1,3,4,5],suit:[3,4],suitabl:[1,4],sum:[1,5],sum_:5,summar:5,summari:[1,3,4,5],superkingdom:[1,5],superphylum:5,suppli:[0,1,3,4,5],support:[0,1,2,4,5],suppress:5,sure:[3,4],suspect:5,sv_bayesian:[1,4,5],sv_interest:[1,5],sv_out:5,sv_sample_na12878:4,sv_simpl:1,svdecompos:2,svg:5,svprep:2,svtype:[1,5],sweep:5,symbol:[3,4,5],synonym:5,synopsi:5,syntax:[2,3],synthet:[3,5],system:[0,1,3,4,5],tab:[1,3,4,5],tabix:[1,4,5],tabl:[1,3,4,5],tabular:[4,5],tacttactttcttcttacttatgtggtaataagctactcggttgggca:1,tag:[1,5],take:[1,3,4,5],taken:[1,3,4,5],talkback:2,tandem:[1,5],tar:5,target:[1,4,5],task:[1,2,3,5],taxa:[1,3],taxdump:5,taxfilt:[1,2],taxid:1,taxon:[1,2,5],taxonom:[2,3,5],taxonomi:[2,4,5],taxonomy_lookup:1,taxstat:[1,2],tbi:4,tcca:1,tcctcca:1,tccttca:1,tcount:5,tdrwgsrfygvlcvpkkegkypallrvpgagir:1,team:5,technic:[2,4,5],technolog:[1,3,4,5],tell:5,temp:5,tempdir:[4,5],templat:[1,5],temporari:[0,4,5],temporarili:5,ten:5,term:[1,5],termin:[0,1,3,4,5],terminolog:5,test:[0,1,3,4,5],text:[0,1,3,4,5],textual:5,tgacgcctctgctcttgcaagtcnttcacattca:1,tgagctgtgtt:1,tggaaggccag:1,than:[1,3,4,5],thei:[0,1,4,5],them:[1,3,4,5],themselv:[3,4,5],theori:1,thereof:1,thi:[0,1,3,4,5],thing:4,think:5,third:[1,3,4,5],thirdli:5,thorough:[1,5],those:[1,3,4,5],though:0,thread:[0,1,5],three:[1,4,5],threshold:[0,1,3,4,5],through:[1,3,4,5],throughout:4,throughput:[1,3,4,5],thu:[1,4,5],thumb:0,tid:[1,4,5],tie:1,tied:4,time:[1,2,3,4,5],tip:[1,5],tissu:4,titl:5,tlen:[4,5],tmp:[4,5],tofix:5,togeth:[1,3,4,5],toler:5,too:[1,3,5],tool:[1,2,3,5],top:[1,4,5],topequ:5,topn:[0,5],torrent:[1,2],tort:1,total:[1,3,4,5],totalmemori:0,tpl:[1,4,5],tpng:[4,5],trace:4,track:[1,4,5],trade:[4,5],trademark:1,tradeoff:5,tradit:5,traffic:[1,3],trail:5,train:[0,2,5],transbord:5,transform:[1,3,5],transit:5,translat:[1,2,3,5],transvers:5,trap:0,tre:[1,4],treat:[1,5],tree:[1,3,4,5],triallel:5,tribe:5,trigg:[1,5],trigger:5,trim:4,trio:[4,5],trio_map:5,trio_vari:4,trivial:5,truncat:[0,5],truth:[4,5],truthi:5,tsm:[1,4,5],tsv:[1,3,4,5],tta:1,ttgg:5,tttaaat:1,tttg:5,tttgcgcgcttgcgcgttt:5,tttt:5,tttttttttctttctttctttctttctttctttctttctttctttctttctttc:5,tumor:[2,3,5],tumor_:4,tumor_map_:4,tumor_reads_:4,tumoronli:[1,2,3,4],tumoronly_out:4,tune:[2,4,5],turn:[1,4,5],two:[0,1,3,4,5],txt:[0,2,3,4,5],type:[1,3,4,5],typic:[0,1,3,4,5],ucsc:[1,4],ucsc_id:4,umich:1,unaffect:[1,5],unalign:5,unambigu:5,unavail:[4,5],unchang:5,unclassifi:1,uncompress:5,undecid:5,undefin:[1,5],under:[1,5],undergo:5,undergon:3,underli:0,underneath:[1,5],undescrib:1,undesir:[4,5],undo:5,unduli:5,unexpect:[4,5],unfilt:5,unfiltered_fin:5,unflatten:5,uniform:[1,5],uniformli:5,union:5,uniqu:[0,1,3,4,5],unit:[1,4,5],unix:[0,3,5],unknown:[1,4,5],unless:[1,4,5],unlik:5,unmap:[1,3,4,5],unmat:[1,3,4,5],unmerg:5,unnam:5,unnecessari:4,unpair:[1,5],unphas:5,unplac:[1,5],unpreced:3,unrel:[3,4],unreli:1,unset:[1,5],unsign:[1,3],until:1,untransl:[1,3,5],unus:5,unusu:4,unwant:3,unwieldi:[1,4],unzip:[1,3],uon:5,updat:[1,3,4,5],upload:1,upon:4,upper:[1,3,5],url:[0,1],usa:1,usag:[1,2,3,5],usageserv:[0,2],use:[0,1,2,3,5],used:[0,1,3,4,5],useful:[0,1,3,5],user:[1,2,3,4,5],usernam:0,uses:[0,1,3,4,5],using:[0,2,3],usr:[1,3],usual:[1,3,5],utah:4,util:[1,2,4],vaf1:[1,5],vaf:[1,5],valid:[1,3,5],valu:[0,1,3,4,5],valuabl:5,vari:[0,1,3,4,5],variabl:[0,1,3,5],varianc:5,variant:2,variat:[0,1,2,5],varieti:[3,4,5],variou:[1,3,5],vcf:[2,3,4],vcfannot:[2,4],vcfdecompos:2,vcfeval:[2,4],vcffilter:[1,2,4],vcfmerg:[2,4],vcfsplit:2,vcfstat:[2,4],vcfsubset:[2,4],vcfv4:[1,3,4],vega:[1,5],vendor:[4,5],verbos:5,veri:[0,1,3,4,5],verif:5,verifi:[1,3,4,5],version1:1,version:[0,1,2,3,4],versu:1,via:[0,1,3,4,5],view:[1,2,3,5],viewer:[3,5],viewpoint:5,violat:5,virtual:[1,3,5],visibl:3,visit:1,visual:[0,1,3,4,5],vof:4,vol1:4,volum:3,vulner:4,wai:[1,4,5],wall:[1,3,4],want:[4,5],ware:[1,5],warn:[4,5],warranti:1,washington:1,waterman:1,web:[4,5],websit:[1,4,5],wedg:[1,5],weight:[4,5],weighted_roc:5,weinberg:[1,5],well:[1,3,4,5],were:[1,5],wget:5,wgs:[4,5],what:[1,4,5],when:[0,1,3,4,5],whenev:[3,5],where:[0,1,3,4,5],wherea:[4,5],whether:[0,1,4,5],which:[0,1,3,4,5],whichev:[3,5],white:1,whole:[1,4,5],whom:1,whose:5,why:3,wide:[3,4,5],widget:5,width:5,wiki:[1,5],wikipedia:[1,5],wild:[1,5],window:[0,1,3,5],wise:4,wish:[0,4,5],within:[0,1,3,4,5],without:[0,1,3,5],word:[1,3,4,5],work:[0,1,4,5],workflow:[4,5],workspac:1,would:[1,3,4,5],wrapper:[1,3],write:[0,1,3,4,5],written:[0,1,3,4,5],wunsch:1,www:[1,4,5],x86_64:0,xattr:[1,3],xmax:5,xmin:5,xml:[1,4],xrx:[1,4],year:5,yes:[1,4],yet:[3,5],yield:[3,4,5],ymax:5,ymin:5,you:[0,1,3,4,5],your:[0,1,3,4,5],yourself:5,ypallrvpgag:1,yyyi:0,zcat:[4,5],zealand:[1,5],zero:[1,4,5],zip:[1,3],zless:4,zook:5,zoom:5,zp_03299218:1,zp_03678041:1,zp_05285664:1,zp_05759216:1,zxf:5,zygos:[1,4,5]},titles:["Administration & Capacity Planning","Appendix","Table Of Contents","Overview","RTG product usage - baseline progressions","RTG Command Reference"],titleterms:{"function":[1,3,5],POS:1,Use:4,Using:[1,4],abund:3,access:1,adapt:5,addit:1,addpacbio:5,administr:0,advanc:[0,5],against:4,align:[1,3],allel:5,alt:1,altern:0,analysi:3,annot:5,api:1,appendix:1,approach:1,assembl:5,assist:3,aview:5,avr:4,avrbuild:5,avrpredict:5,avrstat:5,bacteri:4,bam:[1,3],baselin:4,bed:1,benchmark:[3,5],bgzip:5,bndeval:5,breakdown:3,build:4,calibr:5,call:4,caller:3,cancer:4,capac:0,cg2sdf:5,cgmap:[1,5],cgsim:5,check:4,checkminvers:1,childsim:5,chrom:1,chrstat:5,cli:5,cnv:[3,5],color:0,column:5,combin:5,command:[0,1,3,5],common:5,compar:5,comparison:5,complex:3,composit:5,comput:1,configur:0,consensu:5,construct:5,contamin:[3,4],content:[1,2],copi:[3,4],coverag:[1,3,4,5],creat:[3,4],curv:5,data:[3,4,5],databas:4,decomposit:5,denovosim:5,deploy:3,descript:[1,3],detect:[3,4,5],directori:1,discord:[1,4,5],distribut:[1,5],dna:4,end:5,ensurefilterhead:1,ensureformathead:1,ensureinfohead:1,error:1,estim:4,evalu:[4,5],exampl:5,except:0,expr:5,express:5,extens:1,extract:5,famili:[4,5],fastqtrim:5,field:1,file:[0,1,3,4],filter:[1,3,4,5],filter_header_str:1,find:4,fly:5,format:[1,3,4,5],format_field:1,format_header_str:1,frequenc:4,gap:1,gener:4,genet:1,genom:4,genomesim:5,graph:5,group:[1,4],gui:5,haploid:4,hapmap:4,has:5,hashdist:5,header:1,help:5,highlight:0,human:4,indel:[3,5],index:[1,5],info:1,info_field:1,info_header_str:1,inform:[1,4],input:[1,3],instal:[0,3,4],instruct:3,interact:5,interfac:5,introduct:3,ion:4,javascript:[1,5],keep:5,licens:[3,5],line:[0,5],lineag:5,log:0,lookup:1,machin:0,manag:[0,3,4],map:[1,3,4,5],mapf:5,mapp:[1,5],mapx:[1,5],mapxrenam:5,match:5,mendelian:[3,5],merg:5,meta:5,metagenom:[3,4,5],mode:[4,5],model:4,modif:1,multi:0,multipl:0,name:4,ncbi2tax:5,normal:4,notic:1,number:[3,4],onli:5,optim:[0,3],option:4,output:[1,3,5],overview:3,pair:5,parallel:[1,3],ped:1,pedfilt:5,pedigre:[1,3,4],pedsamplesim:5,pedstat:5,perform:[0,4,5],petrim:5,pipelin:[3,5],plan:0,ploidi:5,popsim:5,popul:[4,5],posit:5,precis:5,prepar:4,print:1,prior:[4,5],process:[1,3],produc:4,product:4,progress:4,protein:[3,4,5],qual:1,qualiti:5,quick:3,read:[1,3,4,5],readm:1,readsim:5,readsimev:5,record:[1,5],ref:1,refer:[1,4,5],region:[1,5],relationship:3,report:4,rescor:5,respect:5,result:1,review:4,roc:5,rocplot:5,rtg:[1,3,4,5],rtg_minimum_vers:1,run:[0,4],sam2bam:5,sam:[1,3],same:5,sammerg:5,sampl:[1,3,4,5],sample_nam:1,samplereplai:5,samplesim:5,samrenam:5,samstat:5,score:[1,4],script:5,sdf2cg:5,sdf2fasta:5,sdf2fastq:5,sdf2sam:5,sdfsplit:5,sdfstat:5,sdfsubseq:5,sdfsubset:5,search:[3,4,5],sensit:[3,5],sequenc:[3,4],set:4,sex:4,similar:[1,4,5],simpl:5,simul:5,singl:[0,4],site:4,small:1,snp:[3,5],softwar:3,somat:[3,4,5],speci:[1,4,5],specif:4,split:5,squash:5,standard:3,start:3,statist:4,string:1,structur:4,support:3,svdecompos:5,svprep:5,syntax:5,tabl:2,talkback:0,task:4,taxfilt:5,taxon:3,taxonom:1,taxonomi:1,taxstat:5,technic:[1,3],time:0,tool:4,torrent:4,train:4,translat:4,trim:5,tumor:4,tumoronli:5,tune:3,txt:1,usag:[0,4],usageserv:5,use:4,user:0,using:[1,4,5],util:[3,5],variant:[1,3,4,5],variat:[3,4],vcf:[1,5],vcfannot:5,vcfdecompos:5,vcfeval:5,vcffilter:5,vcfmerg:5,vcfsplit:5,vcfstat:5,vcfsubset:5,version:5,versu:5,view:4}}) \ No newline at end of file +Search.setIndex({docnames:["administration","appendix","index","overview","product_usage","rtg_command_reference"],envversion:{"sphinx.domains.c":2,"sphinx.domains.changeset":1,"sphinx.domains.citation":1,"sphinx.domains.cpp":3,"sphinx.domains.index":1,"sphinx.domains.javascript":2,"sphinx.domains.math":2,"sphinx.domains.python":2,"sphinx.domains.rst":2,"sphinx.domains.std":1,sphinx:56},filenames:["administration.rst","appendix.rst","index.rst","overview.rst","product_usage.rst","rtg_command_reference.rst"],objects:{},objnames:{},objtypes:{},terms:{"0_07":0,"0_161":5,"0bfc":0,"0daf":1,"0gb":5,"0x02":1,"0x08":1,"0x100":1,"1000g_v37_phase2":4,"1000genom":4,"100m":4,"1219061gi":1,"143_____1":1,"15_grch38":4,"15_grch38_no_alt_plus_hs38d1_analysis_set":4,"16g":5,"1b19":1,"1i11":1,"1i14":1,"1r1":1,"1r2":1,"1r5":1,"1r5n10":1,"1sampl":5,"1t2":1,"1x1":1,"1x11":1,"1x15":1,"1x19":1,"20human":4,"20humans_an_ac":4,"20humans_prior":4,"283m1d1i32n8m":1,"2a36ba21397":1,"2b20":1,"2b5":1,"2sampl":5,"2x18":1,"2x46":1,"314_pool30":4,"36c48ec4":1,"3gb":5,"3sampl":5,"4157329b":1,"419a":1,"41d195dec4cd":1,"44116e7a2195":1,"454_pe":5,"454_read":5,"454_sdf":5,"454_se":5,"455d":1,"467b":4,"48d5":1,"48e6":1,"48g":[0,1,3],"4b11":1,"4d74":1,"4ecc9eb83e0ccec4":1,"4f6c2eca":0,"52b7":1,"5c2ee18":1,"5n10":1,"5n23":1,"5n25":1,"5n8":1,"6236f4e":5,"6aef897c3d6ff0c78aff06ac189178dd":4,"70s":1,"718f8317b7":5,"71dce5dba129":1,"73e374719c7f":4,"7798b1a5":1,"79d6626":1,"7ded37d7":4,"7f77":1,"817f":4,"86b4f8e98fa6":1,"8acc8413":1,"96ca":1,"976e":1,"9f7b8a5":1,"boolean":5,"break":[1,3,4,5],"byte":3,"case":[0,1,3,4,5],"class":5,"default":[0,1,3,4,5],"export":5,"final":[4,5],"float":[1,5],"function":[2,4],"import":[1,4,5],"int":5,"long":[1,5],"na\u00efv":5,"new":[0,1,3,4,5],"null":[1,5],"public":[1,3,4],"return":[1,5],"short":[1,3,4,5],"switch":[3,4,5],"throw":5,"true":[0,1,5],"try":4,"typeof":5,"var":[1,5],"while":[1,4,5],ADE:1,AND:1,ARE:1,Adding:[0,1],And:[1,5],BOING:1,BUT:1,But:1,DHS:1,DOING:1,DOS:5,Doing:5,FOR:1,For:[0,1,3,4,5],IDs:[1,3,4,5],INS:5,NCS:[1,4,5],NOT:1,Not:[4,5],One:[1,3,4,5],SAS:3,SUCH:1,Such:[1,5],THE:1,The:[0,1,3,4,5],Then:[0,4,5],There:[1,3,4,5],These:[0,1,3,4,5],USE:1,Use:[0,1,2,3,5],Used:[1,5],Uses:5,Using:[2,3,5],WGS:5,WITH:1,Will:1,With:[0,1,3,4,5],_____27:1,_indel:5,_renam:5,a10:1,a7da:4,aagtacttcttagttcaattactatcatcatcttacctaattactact:1,aat:1,aatacttttcattctttactattacttacttattcttacttacttact:1,abbrevi:5,abc:1,aberr:[3,5],abi:1,abil:[0,3,4,5],abl:[1,4,5],abnorm:[4,5],about:[1,3,4,5],abov:[0,1,4,5],abp:[1,4],abs:5,absenc:5,absent:5,absolut:5,abund:[1,2,4,5],acaryochloris_marina:1,accacct:1,accept:[1,3,4,5],access:[0,2,3,4,5],accessor:1,accg:1,accgttgactctgtgacgctgcacgtacgt:1,accommod:[3,4],accompani:[1,3,5],accomplish:[1,3,4,5],accord:[3,4,5],accordingli:5,account:[1,4,5],accumul:[1,3],accur:[1,4,5],accuraci:[3,4,5],acgc:5,acgt:1,achiev:[4,5],acholeplasma_laidlawii:1,acid:[1,5],acidiphilium_cryptum:1,acidobacteria_bacterium:1,acidothermus_cellulolyticu:1,acidovorax_avena:1,across:[1,3,4,5],act:5,action:1,actual:[1,3,4,5],adam:1,adapt:[1,4],adaptor:5,add:[0,1,5],added:5,adding:[0,1,3,5],addit:[0,2,3,4],addition:[0,4,5],addpacbio:2,address:5,adequ:4,adf1:1,adf2:1,adf:1,adjac:[1,4,5],adjust:[1,3,4,5],administr:[1,2,3],adr1:1,adr2:1,adr:1,advanc:2,advantag:[3,5],advers:4,advic:[3,5],advis:1,affect:[1,4,5],affin:5,afflict:[4,5],after:[0,1,3,4,5],agaggagagaacnggtttggaaccattc:1,against:[1,2,3,5],age:1,aggcgtctgcagccgacgcg:5,aggreg:5,aggress:3,agre:[1,5],agreement:[1,5],aim:[4,5],aka:5,alan:[1,5],algorithm:[1,3,4,5],alia:5,align:[2,4,5],alignments1:5,alignments2:5,alignments_renam:5,all:[0,1,3,4,5],allel:[1,4],allevi:5,alloc:[0,1,3],allosom:1,allow:[1,3,4,5],alon:1,along:[1,3,4,5],alongsid:5,alphanumer:1,alreadi:[1,4,5],also:[0,1,3,4,5],alt:5,altdepth:5,alter:[0,1,3,4,5],altern:[1,2,3,4,5],although:[0,1,4,5],altogeth:5,alwai:[1,3,4,5],ambigu:[1,3,4,5],amino:[1,5],amongst:4,amount:[0,4,5],amplif:4,amplifi:3,amqv00000000:1,amqv01000000:1,amqv01000002:1,amqv01000004:1,amqv01000006:1,anagaacnggaaccattcatggaaggccagagtga:1,anagaactgg_____aaccattcatggaaggccagagtga:1,anagaactggaaccattcatggaaggccagtga:1,analys:5,analysi:[0,1,2,4,5],analyt:[3,5],analyz:[3,5],anchor:5,ancillari:3,ani:[0,1,3,4,5],anim:1,ann:5,annot:[1,3,4],announc:[1,3],anomali:4,anonym:4,anoth:[0,1,4,5],ansi:0,ansicon:0,ant:1,anywher:1,apach:1,api:[2,5],appear:[1,5],append:5,appendix:[2,3,5],appl:[1,3],appli:[0,1,4,5],applic:[0,1,3,4,5],approach:[2,3,4,5],appropri:[0,1,3,4,5],approxim:[4,5],arbitrari:[4,5],arch:0,archiv:4,area:[1,3,5],arg:5,argument:[0,1,3,5],aris:[1,3,4,5],arithmet:4,arm:[1,3,5],around:[1,5],arrai:[1,5],arrang:5,artifact:5,ascend:5,ascii:[1,3,5],ask:0,assembl:[2,4],assert:5,assign:[0,1,3,5],assist:[1,2,4,5],associ:[1,3,4,5],assum:[0,1,3,4,5],assumpt:5,assur:3,ata:0,atcgtaaaataaatgca:5,atcgtaaataaaatgca:5,atgc:5,atgg:5,att:5,attach:5,attempt:[1,5],attract:5,attribut:[1,3,4,5],atttt:5,aug:4,augment:[0,5],australia:[1,5],author:[1,5],auto:[0,5],autom:3,automat:[0,1,3,4,5],autosom:[1,4,5],avail:[0,1,3,4,5],averag:[1,4,5],aview:2,avoid:[1,5],avr:[0,1,2,5],avrbuild:[2,4],avrpredict:[2,4],avrstat:[2,4],awai:[1,5],awar:[1,3,4,5],awk:[4,5],axes:5,axi:5,b06:0,b14:4,b1f96b37:1,b37:4,b472:1,b6318de1:1,b68c:1,b7baa85ebf66:0,b7ed:4,bac:1,bac_map:1,bac_reads_sdf:1,bac_ref_sdf:1,back:[1,5],background:5,backstep:1,bact:5,bact_db:5,bact_read:5,bact_sampl:5,bacteri:[2,3],bacteria:[1,4],bacteriophage_kvp40:5,bad:[1,3,4,5],bai:4,balanc:[3,4,5],bam:[2,4,5],band:5,bang:1,banner:5,bar:5,bare:1,barrier:5,base:[0,1,3,4],baselin:[2,3,5],baseline_sampl:5,basenam:4,bash:[1,3,5],basi:[1,3,4,5],basic:[1,3,4],bat:[0,1,3],batch:4,battel:1,bayesian:[1,3,4,5],baz:1,bdd9:1,be70:0,beagl:1,becaus:[1,3,4,5],becom:[4,5],bed:[2,3,4,5],bedgraph:[1,5],bedtool:4,been:[1,3,4,5],befor:[1,5],beforehand:5,begin:[3,5],behav:5,behavior:[0,4,5],being:[1,3,4,5],belong:1,below:[1,3,4,5],benchmark:[0,2],bergman:1,best:[1,3,4,5],better:[1,3,4,5],between:[1,3,4,5],beyond:4,bf9f:1,bgzip:[1,2,4],bherer:1,bherer_etal_sexualdimorphismrecombin:1,bia:[1,4,5],biallel:5,bias:5,bidirect:5,billion:1,bin:[1,3,5],binari:[1,3,4,5],biodefens:1,bioinformat:3,biolog:3,biologi:[1,5],biorxiv:5,bioscienc:5,biostat:1,bit:[1,3,5],blacklist:5,blade:0,blank:1,blast:[1,5],blastp:5,blastx:[3,5],blind:5,blind_13:5,blind_15:5,blind_8:5,block:[4,5],blosum45:5,blosum62:[3,5],blosum80:5,bnbi:1,bnd:[1,5],bndeval:2,board:0,bochet:1,bodi:3,border:5,boston:1,both:[1,3,4,5],bound:[1,3,5],boundari:[1,4,5],braithwait:[1,5],branch:5,brand:1,breadth:[1,3,4],break_out:5,breakdown:[2,5],breakend:[1,4,5],breakpoint:[1,4,5],brewer_acc:5,brewer_dark2:5,brewer_pair:5,brewer_pastel1:5,brewer_pastel2:5,brewer_set1:5,brewer_set2:5,brewer_set3:5,brian:[1,5],bring:5,broad:[1,4],broadinstitut:4,broadli:5,broken:1,browser:[4,5],bruijn:5,bubbl:5,bucket:[4,5],bui:5,build37:5,build:[0,1,2,3,5],builder:5,built:[1,3,4,5],bundl:4,busi:1,button:5,bz2:5,bzip2:[1,5],c0561a1d:1,c477b940:4,c_sampl:5,cach:0,cad2cc3c476a:1,calcul:[1,3,4,5],calibr:[1,2,3,4],call:[0,1,2,3,5],callabl:4,caller:[1,2,4,5],calls_sampl:5,came:5,can:[0,1,3,4,5],cancer:[1,2,3,5],candid:[1,5],cannot:5,cap:5,capabl:[0,1,3,4,5],capac:[2,3],captur:[4,5],card:5,care:[4,5],carri:[4,5],cat:[1,4],categor:[1,5],categori:[1,5],caus:[1,5],causal:3,caution:5,caveat:4,cbherer:1,ccaaaaataagt:1,cccccca:1,ccctcca:1,cctcctagcggtacatctccagccccttcctagna:1,cctggagg:1,ceil:5,cell:[1,5],cellular:1,center:[0,1,3],centimorgan:1,central:[0,1],ceph:[4,5],ceph_pedigre:5,certain:[1,5],certainli:5,ceu:4,ceu_trio:5,cfg:[0,1,3],cftr:1,cg1:[4,5],cg2:[4,5],cg2sdf:[2,3,4],cg_3x_readst:5,cg_map:5,cg_read:5,cg_source_fil:5,cggaggggagggcgcggagcggagg:5,cggaggggagggcgcggagcggaggggagggcgcggagcggagg:5,cgi:[1,4,5],cgmap:[2,3,4],cgmap_sample_na12878:4,cgsim:[2,3],cgt:1,chain:1,chanc:[4,5],chang:[1,3,4,5],chapter:[1,3,4,5],charact:[0,1,4,5],characterist:[1,3,4,5],charg:1,chart:[1,4,5],check:[1,2,5],checkbox:5,child:[1,4,5],children:[4,5],childsim:[1,2,3],chines:5,choic:[4,5],choos:[0,4,5],chosen:[1,4,5],chr10:[1,4,5],chr11:[1,4],chr12:[1,4],chr13:[1,4],chr14:[1,4],chr15:[1,4],chr16:[1,4],chr17:[1,4],chr18:[1,4],chr19:[1,4],chr1:[1,4,5],chr1_ki270706v1_random:4,chr1_ki270707v1_random:4,chr1_ki270708v1_random:4,chr20:[1,4],chr21:[1,4,5],chr22:[1,4],chr2:[1,4],chr3:[1,4],chr4:[1,4],chr5:[1,4],chr6:[1,4],chr7:[1,4],chr8:[1,4],chr9:[1,4],chr:[1,4,5],chrm:[1,4],chrom:5,chrominfopag:1,chromosom:[1,3,4,5],chrstat:2,chrx:[1,4,5],chry:[1,4],chunk:[1,5],cigar:[1,5],cipo:[1,5],circular:[1,4],circumst:5,citat:5,cite:1,clade:5,claim:1,clariti:1,classic:5,classif:5,classifi:[3,5],classpath:1,clear:[1,3,5],cleari:[1,5],cli:[2,3],click:5,clip:[1,5],clist:1,clock:[0,1,3,4],close:[1,5],closer:5,closest:[1,4,5],clu:1,cluster:[0,1,3,4,5],cm000663:4,cmb:[1,5],cmd:5,cmpk:1,cmpkasgnypallrvpgag:1,cnv:[1,2,4],cnv_s1_:4,cnv_s1_s2:4,cnvsim:5,code:[1,4,5],coeffici:1,cohort:5,coli:4,collaps:[4,5],collat:[0,5],colleagu:5,collect:[0,4,5],collis:5,color:[2,5],column:[1,3,4],com:[1,3,4,5],combin:[1,3,4],come:[3,5],comma:[0,1,5],command:[2,4],commandlin:0,commenc:5,comment:[1,4,5],commerci:[0,3],common:[1,3,4],commonli:[0,5],commun:[3,4,5],comp_out:5,compar:[3,4],comparison:[0,1,3,4],compat:5,compens:5,complement:[1,5],complet:[1,3,4,5],complete_genom:5,complete_genomics_2:5,completegenom:[1,4,5],complex:[1,2,4,5],complianc:1,complic:5,compon:[1,3,4,5],composit:[2,3],comprehens:[1,3,5],compress:[0,3,4,5],compris:[1,3,4,5],comput:[0,2,3,4,5],computation:[4,5],con:4,concaten:5,concept:5,conceptu:[3,5],concern:5,conclus:5,concord:5,condit:[0,1,4,5],conemu:0,confid:[1,3,5],confidenti:0,configur:[1,2,3,4,5],conjunct:[4,5],connect:[1,5],consensu:3,consequ:5,consequenti:1,conserv:5,consid:[1,4,5],consider:[4,5],consist:[0,1,3,5],consol:[0,5],constant:1,constitu:5,constitut:4,constrain:5,constraint:[1,3,5],construct:[1,3,4],consult:[1,5],consum:5,consumpt:5,contact:[1,3,4,5],contain:[0,1,3,4,5],contamin:[2,5],content:[0,5],context:[1,5],contig:[1,4,5],contigu:5,continu:[1,5],contract:1,contrari:[1,5],contrast:5,contribut:[1,5],contributor:1,control:[0,3,5],convei:1,conveni:[1,4,5],convent:[1,5],convers:[1,3,4,5],convert:[1,3,4,5],convex:5,coordin:[1,4,5],cope:4,copi:[0,1,2,5],copyright:1,core:[0,1,3,5],correct:[1,3,4,5],correctli:[4,5],correspond:[1,4,5],cosm3805:1,cosmic:[4,5],cost:[1,3,5],could:[1,4,5],count:[1,4,5],countermeasur:1,coupl:5,cours:4,cov_sample_na12878:4,cover:[1,3,4,5],coverag:[0,2],coverage_level:1,coveragetsv:5,cpu:[0,3,5],cram:5,crash:0,creat:[0,1,2,5],creation:[1,4,5],credit:5,criteria:[1,5],criterion:5,crop:3,cross:[3,4,5],crossov:[1,5],ctcatggaga:1,ctt:5,cttaaac:1,cttaac:1,cttt:5,cumul:[1,4],curat:5,current:[0,1,3,4,5],custom:[0,1,3,4],customis:5,customiz:3,cut:5,cutoff:[4,5],cyanobacteria:1,d74f45d:0,d_sampl:5,damag:1,dash:5,data:[0,1,2],databas:[1,2,3,5],dataset:[0,1,5],date:[0,1,4,5],daughter1:5,daughter2:5,daughter:[3,4,5],davi:5,david:[1,5],dbsnp:[4,5],dcoc:[1,5],dcof:[1,5],ddr3:3,deal:[1,4,5],debug:[3,5],decid:[1,5],decim:5,decis:[0,1,5],declar:[1,5],decod:5,decoi:[1,4],decompos:5,decompress:[1,4,5],decreas:[3,4,5],dedic:1,deep:3,deeper:[3,4],def:1,defin:[0,1,3,4,5],definit:[1,5],degre:[4,5],del:5,delet:[1,3,4,5],delimit:[1,5],delin:3,deliv:[1,3,5],delta:[1,5],demand:[0,1,3],demo:1,demonstr:[0,4,5],denot:[1,4,5],denovo:5,denovosim:[2,3],dens:[4,5],densiti:5,depart:[1,5],depend:[0,1,3,4,5],deploy:[0,1,2,5],depth:[1,3,4,5],deriv:[1,3,4,5],descend:[1,5],describ:[0,1,3,4,5],descript:[0,2,4,5],design:[1,3,5],desir:[0,1,3,4,5],destin:[0,5],detail:[1,3,4,5],detect:[0,1,2],determin:[0,1,3,4,5],determinist:5,develop:[1,3,4,5],deviat:[1,5],dh10b:4,diagram:5,dictionari:1,did:[3,4,5],didn:5,differ:[0,1,3,4,5],difficult:5,difficulti:5,dimension:[1,4,5],diploid:[1,3,4],dir:[3,5],dir_map:5,direct:[1,5],directli:[0,1,3,4,5],directori:[0,2,3,4,5],disabl:[0,5],disagre:1,disambigu:5,discard:[1,3,4,5],disclaim:1,disconnect:5,discord:2,discord_pair:1,discord_sample_na12878:4,discordantli:[1,4,5],discov:[1,4],discrep:5,discuss:[1,3,5],diseas:3,disk:[0,3,4,5],displai:[0,1,3,4,5],distanc:[1,3,5],distinct:[1,4],distribut:[2,3,4],divers:[1,3],diversity_index:1,divid:[0,1,5],dna:[1,2,3,5],dnp:[1,5],document:[0,1,4,5],doe:[1,3,4,5],doesn:5,doi:[1,5],doing:[1,4],dokladi:1,domin:5,don:[4,5],done:[1,4,5],dot:[4,5],doubl:[1,5],doubt:5,down:5,download:[1,4,5],downstream:[3,4,5],dp10to20:5,dp20to30:5,dp30to40:5,dpr:[1,4],drag:5,dramat:[1,5],draw:5,drawn:5,drive:0,drop:[4,5],drtg:0,dual:3,due:[1,3,4,5],dump:[1,5],duo:0,dup:[1,5],duplic:[1,4,5],dure:[0,1,3,4,5],duster:5,dynam:[1,5],e9e7:4,each:[0,1,3,4,5],eap2:1,earlier:[1,5],eas:[3,5],easi:[3,5],easier:[1,3,4,5],easili:[1,4,5],ebi:4,echo:1,ecoli:4,ecolog:1,edb9:1,edg:1,edit:[0,1,3,5],editor:4,edu:1,effect:[1,4,5],effici:[1,3,4,5],effort:1,either:[1,3,4,5],elaps:5,elimin:3,ell:5,els:5,elsewher:4,email:3,embark:5,embed:0,emploi:[1,3,4,5],empti:[0,5],enabl:[0,1,3,4,5],encapsul:1,encod:[1,5],encompass:5,encount:[0,1,3,5],end:[3,4],endors:1,engin:[4,5],enhanc:[0,3],enough:5,ensur:[1,3,4,5],ensureformathead:5,enter:[1,3,5],enterpris:3,entir:[1,3,4,5],entireti:5,entri:[1,5],env:[1,3],environ:[0,1,3,5],equal:[1,3,4,5],equilibrium:[1,5],equival:[1,3,4,5],ergonom:3,erron:3,error:[3,4,5],escherichia:4,escherichia_coli_k_12_substr__dh10b_uid58979:4,especi:[3,5],essenti:[1,5],establish:[1,3],estim:[0,1,2,3,5],etc:[1,3,4,5],european:4,eval:5,eval_:5,eval_famili:5,eval_family_roc:5,evalu:[1,2,3],even:[1,5],event:[1,5],everi:[0,1,3,4,5],evid:[1,3,5],evolv:1,exac:5,exact:[1,3,5],exactli:[1,4,5],examin:[3,4,5],exampl:[0,1,3,4],exce:[0,1,5],exceed:[1,5],excel:[3,4],except:[1,2,4,5],excerpt:1,excess:[4,5],exclud:[4,5],exclus:[1,5],execut:[0,1,3,4,5],exemplari:1,exist:[1,4,5],exit:1,exom:[1,4,5],expect:[0,1,3,4,5],expens:[3,5],experi:[3,4,5],experiment:4,expir:5,explan:[3,5],explicit:[4,5],explicitli:[0,1,4,5],explor:5,expr:1,express:1,extend:[1,3,5],extens:[0,2,3,4,5],extern:[1,4,5],extra:[0,1,4,5],extract:[2,4],extrem:[1,5],f1_g_s_1m:1,f1_n_an_1m:1,f1_o_bm_1m:1,f1_o_sp_1m:1,f1_o_td_1m:1,f1_v_pf_1m:1,f8968de308e3:4,f_sampl:5,facil:4,facilit:5,factor:[1,5],fail:[0,1,4,5],fail_val:1,failur:5,fairer:5,fairli:[1,5],fall:[1,5],fals:[0,4,5],falsi:5,fam01:1,fam:[1,4,5],famili:[1,2,3],familiar:[3,5],family1:5,family_sim:5,farther:5,fashion:4,fast:[3,4,5],fasta:[3,4,5],faster:[0,4,5],fastq:[3,4,5],fastqtrim:2,fatal:0,father:[1,3,4,5],father_gt:5,favor:1,fb3b:1,fb8b6b34c5d0:1,featur:[0,1,3,4,5],feb:4,fed:5,feder:1,feedback:0,femal:[1,4,5],few:[1,4,5],fewer:[4,5],field:[0,2,3,4,5],fifth:1,figur:0,file:[2,5],filed:1,fileformat:1,filenam:5,fill:[4,5],filter:2,filtered_sample_na12878:4,find:[1,2,3,5],fine:[0,1,5],finish:[0,4],firefox:4,firmicut:5,first:[0,1,3,4,5],firstli:5,fit:[1,3],five:[1,5],fix:[3,5],flag:[0,1,3,4,5],flatten:1,flexibl:[3,5],flip:5,floor:[1,5],flourish:5,flow:5,fn_ca:5,fna:4,focu:4,focus:[3,5],fold:[1,4,5],follow:[0,1,3,4,5],forc:5,foreach:5,form:[0,1,3,4,5],format:[0,2],former:5,formerli:1,formula:[1,5],fortun:1,forum:[1,3],forward:[1,5],found:[1,4,5],foundat:1,founder:[4,5],four:[1,3],fourth:4,fp_ca:5,frac:5,fraction:[1,3,4,5],fragment:[1,5],frame:1,francisco:[1,5],franklin:1,free:[0,1,3],freememori:0,freq:5,frequenc:[2,3,5],frequent:[1,5],friendli:5,from:[0,1,3,4,5],front:5,ftp:[4,5],full:[0,1,3,4,5],fulli:[1,4,5],fund:1,furnish:1,further:[0,1,3,4,5],g1_samp:5,ga4gh:5,gaastra:[1,5],gac:1,gactctctgacgctgcncgtacgtgccaaaaataagt:1,gagtgctgcaggccgaccagcaactcatggagaagaccaagg:1,gain:5,gap:[2,3,4,5],gc55to60:5,gc60to65:5,gca:4,gca_000001405:4,gcc:1,gccontent:5,gcg:1,gcgcgcgcgcg:5,gena:1,genb:1,gender:1,gene:5,gener:[0,1,2,3,5],genet:[2,3,5],genetic_map:1,genom:[0,2,3],genome_ref:5,genomesim:[2,3],genometest:5,genotyp:[1,4,5],genu:5,genuin:5,germlin:[1,4,5],get:[1,5],ggaaggagtgctgcaggccgaccctcatggaga:1,ggaaggggagtgctgcaggccgacc:1,ggaaggggagtgctgcaggccgaccctcatggaga:1,ggi:4,ghz:0,gigabyt:0,github:[1,3,4,5],give:[0,3,4,5],given:[1,3,4,5],glob:5,global:[1,3,5],gnu:1,gnuplot:3,gold:5,goldstandard:5,good:[1,3,4,5],googl:[1,3],gov:[4,5],govern:[1,5],gqd:[1,4,5],gradient:5,grain:5,grant:1,granular:5,graph:4,graphic:[1,3,5],graphviz:[4,5],grch37_gc55to60_slop50:5,grch37_gc60to65_slop50:5,grch38:4,greater:[1,3,5],greatli:5,grep:5,gridhost:0,gross:5,ground:5,group:[0,2,3,5],gs002290:4,gs00290:4,gsapubftp:4,gsr:1,gsrt:1,gsrtfgi:1,gtct:5,guarante:[3,4,5],guest:5,guid:[1,3],guidelin:3,gunzip:5,gut:4,gzip:[1,5],gzipfix:1,gzipinputstream:1,h1_base:5,h1_cnv:5,h1_coverag:5,h1_read:5,h1_sample_left:5,h1_sample_right:5,h1_test:5,had:[1,5],hair:5,half:[1,3,5],hand:[4,5],handl:[0,1,3,4,5],hap:5,haploid:[1,2,3,5],haplotyp:[4,5],hapmap:2,hapmap_3:4,happen:5,hard:5,hardi:[1,5],hardwar:[0,5],harvard:1,has:[0,1,3,4],hash:5,hashdist:2,hashmap:5,have:[0,1,3,4,5],haven:5,head:4,header:[2,4,5],held:1,help:[1,2,3,4],helper:1,here:[0,3,4,5],herebi:1,herein:1,het:[1,5],heterogen:5,heterozyg:[1,3,5],heterozygos:[1,5],hexaploid:1,hg18:1,hg19:[1,4,5],hgsid:1,hgtrack:1,hide:5,hierarch:1,high:[0,1,3,4,5],higher:[1,3,4,5],highest:[4,5],highli:[0,3,5],highlight:[2,5],hilbush:[1,5],histogram:[3,5],hit:[1,3,4,5],hold:[0,1,4,5],holder:1,hom:[1,5],home:5,homeland:1,homolog:[3,4],homopolym:[1,5],homozyg:[1,3,5],hope:1,host0:1,host1:1,host:[0,1,3,4],hostnam:[0,1,3],hotspot:5,hour:4,how:[1,3,4,5],howev:[0,1,3,4,5],hs37d5:4,hs38d1:4,hs_map:5,hs_refer:5,hs_snp:5,hshqdc:1,hslo:1,hst1:1,html5:[1,4,5],html:[1,3,4,5],hts:[1,3,4],htsjdk:1,http:[0,1,3,4,5],hull:5,human:[0,1,2,3,5],human_protein_read:5,human_reads_sdf:[1,5],human_ref:5,human_ref_sdf:[1,5],human_refer:[4,5],humanfasta_return:5,humanfastq_return:5,humanmapping8:1,humansdf:5,hyper:1,hypercomplex:1,hypothes:[1,4],hypothesi:[1,4,5],i_22:5,i_7:5,idea:[1,4,5],ideal:4,ident:[1,3,4,5],identif:[1,3,5],identifi:[1,3,4,5],ids:[4,5],ign:5,ignor:[1,4,5],igv:5,illumina1:5,illumina:[1,3,4,5],illumina_p:5,illumina_read:5,illumina_s:5,illumina_sdf:5,illustr:5,imag:[4,5],imagemagick:5,imbal:1,immedi:5,immut:1,impact:[0,5],imping:5,implement:3,impli:[1,5],imprecis:1,improv:[0,3,4,5],impur:5,imput:[1,5],inaccur:5,inadequ:4,inappropri:5,inbreed:1,inc:[1,3,5],incident:1,includ:[0,1,3,4,5],inclus:[1,5],incom:5,inconsist:[1,4,5],incorpor:[4,5],incorrect:[4,5],incorrectli:[1,4,5],increas:[1,3,4,5],increment:5,incur:[1,5],ind:[1,4,5],indel:[1,2,4],independ:[0,1,3,4,5],index:[0,2,3,4],indic:[0,1,3,4,5],indirect:1,individu:[1,3,4,5],industri:[3,5],inexactli:5,infer:4,info:[4,5],inform:[0,2,3,5],ingli:[1,5],inherit:[1,3,4,5],initi:[1,3,4,5],initial_assembl:5,inner:1,innov:3,input:[0,2,4,5],input_readgroup_id:5,ins_1:5,ins_a:5,insert:[1,3,4,5],insid:[1,5],insight:5,inspect:[3,4,5],instal:[1,2,5],instanc:[4,5],instead:[0,1,3,4,5],institut:[0,1,4],instruct:[1,2,4,5],insuffici:4,integ:[1,5],integr:[3,5],intel:[0,3],intend:[1,3,5],intens:[1,5],interact:[1,3,4],interest:[1,4,5],interfac:[2,3],interleav:5,intermedi:5,intern:[0,1,3,4,5],internet:0,interpol:5,interpret:[1,3,5],interrupt:1,intersect:[1,3,4,5],interv:[1,4,5],introduc:[1,3,4,5],introduct:[2,5],inv:5,invers:[1,5],inverse_simpson_index:1,invert:5,investig:[0,3,4,5],invok:[4,5],involv:[4,5],ion:[1,2,5],iont:1,iontorr:[1,4,5],irrelev:5,irrespect:5,irvin:[1,5],isn:5,issu:[3,4,5],iter:3,its:[1,3,4,5],itself:[1,5],iupac:4,jackson:[1,5],jar:[0,1,3],java:[0,1,3,5],javascript:2,jivesoftwar:4,job:[0,1,3,4,5],john:[1,5],join:[1,5],joint:[1,3,4,5],jointli:[4,5],journal:[1,5],jre:[1,3],june:[1,5],just:[0,4],justin:5,jvm:[0,3,5],keep:[1,4],kei:[3,5],kept:[4,5],kind:[1,4,5],kmer:5,know:[4,5],knowledg:[1,5],known:[1,3,4,5],krona:1,kurt:[1,5],kvp40_sample1:5,kvp40_sample2:5,label:[1,3,5],lack:5,lal:[1,4,5],lambda:1,lane:[1,4],lane_id:4,languag:1,laptop:[0,3],larg:[0,1,3,4,5],larger:[4,5],largest:[4,5],last:[1,4,5],later:[0,1,4,5],latter:[4,5],launch:5,law:1,layout:5,lead:[1,3,4,5],leaf:5,learn:[4,5],least:[1,3,4,5],leav:[0,4],left:[1,3,4,5],left_fq:4,legaci:5,len:[1,5],length:[0,1,3,4,5],lenient:5,leq:1,less:[1,3,4,5],let:5,level:[0,1,3,4,5],levenshtein:1,leverag:3,liabil:1,liabl:1,librari:[1,5],licens:[0,1,2],lies:5,life:1,lifetech:4,lift:4,ligat:5,lightweight:5,like:[1,3,4,5],likelihood:[1,3,5],limit:[0,1,3,4,5],lin:[1,5],line:[1,2,3,4],lineag:[1,2],linear:[1,4,5],link:5,linkag:[1,5],linux:[1,3],list:[0,1,3,4,5],listen:[0,5],liter:[1,5],littin:[1,5],littl:[0,1],llc:1,load:[1,3,4,5],local:[0,1,5],locat:[1,3,4,5],loci:[3,5],log10:1,log:[2,3,4,5],log_10:1,logic:5,loh:[1,4,5],longer:[3,5],longest:1,look:[1,4,5],lookup:[2,5],loop:[1,4],loss:[1,5],lot:[4,5],low:[1,3,4,5],lower:[1,3,4,5],ls454:[1,4,5],ls454_pe:5,ls454_se:5,m_sampl:5,mac:0,macbook:0,machin:[1,2,3,4,5],maco:[1,3],made:[1,3,4,5],mai:[0,1,3,4,5],main:[4,5],mainindex:3,maintain:3,maize_chr:5,maize_refer:5,major:0,make:[0,1,3,4,5],malakshah:[1,5],male:[1,4,5],mammalian:4,manag:[1,2,5],mandat:5,mani:[0,1,3,4,5],manipul:[1,5],manner:[1,4],manual:[0,1,3,4,5],manufactur:5,map:[0,2],map_out:5,map_popul:4,map_rs:5,map_sample1:4,map_sample_na12878:4,map_temp_sample1:4,map_trio:4,mapf:[2,3,4],mapp:[2,3,4],mapper:5,mapq:[1,5],mapx1:5,mapx2:5,mapx:[2,3,4],mapx_out:5,mapx_result:4,mapxrenam:2,mar:4,mark:[4,5],marker:3,markup:0,mask:[4,5],mat:[1,4,5],match:[1,3,4],mate:[1,3,4,5],materi:[1,4,5],matern:[1,5],math:5,matric:1,matrix:[1,3,4,5],matter:4,max:[1,3,4,5],maxaltdepth:5,maxdel:5,maxim:[3,5],maximis:5,maximum:[0,1,4,5],maxin:5,maxscor:1,mcp:5,mcu:5,mcv:5,mean:[1,4,5],meaning:[1,5],meaningfulli:5,meaningless:5,meanqad:[1,5],meant:3,measur:[4,5],mechan:[0,3,5],med_qual:5,medic:3,medicin:3,meet:[0,1,5],mehul:[1,5],member:[3,4,5],memori:[0,1,3,4,5],mendelian:[1,2,4],menu:5,mer:[1,3,4,5],merchant:1,merg:[1,4],messag:[1,3,4,5],met:[1,4],meta:[2,3],metabol:3,metadata:[3,4,5],metagenom:[0,1,2],method:[0,1,5],metric:[1,5],mgh:1,microbi:[1,3],microsoft:[3,4],midpoint:5,might:[1,3,4,5],million:[1,4],min:[1,4,5],minim:[3,4,5],minimum:[0,1,4,5],minor:1,mis:5,mislabel:5,mismatch:[1,3,5],miss:[1,4,5],mit:1,mitochondria:1,mix:[3,5],mixtur:[1,3],mkdir:4,mnp:[1,3,4,5],mode:[2,3],model:[0,1,2,3,5],modif:[2,3,5],modifi:[1,3,4,5],modul:[0,1],molecular:1,monitor:3,month:0,more:[0,1,3,4,5],mosaic:5,most:[1,3,4,5],mostli:3,mother:[1,3,4,5],mother_gt:5,mount:0,move:[4,5],ms_8399:4,ms_auto_b14:4,much:[3,4,5],multi:[1,2,3,4,5],multiallel:5,multipl:[1,2,3,4,5],multipli:5,must:[0,1,3,4,5],mutat:[1,3,5],mylan:0,mypedigre:5,myregion:1,mysamrg:1,mysdf:5,n_sampl:5,na12877:[1,4],na12878:[1,4,5],na12878_gs002290:4,na12878_l001:4,na12878_l001_1:4,na12878_l001_2:4,na12878_map:5,na12878model:4,na12878trio:4,na12879:4,na12880:4,na12881:4,na12882:4,na12883:4,na12884:4,na12885:4,na12886:4,na12887:4,na12888:4,na12889:[4,5],na12890:[4,5],na12891:[4,5],na12892:[4,5],na12893:4,na19238:1,na19239:1,na19240:[1,4,5],na24143:5,na24149:5,na24385:5,na24631:5,na24694:5,na24695:5,naa:[1,5],name:[0,1,2,3,5],namedata0:3,nameindex0:3,namepointer0:3,namespac:5,nation:1,nativ:4,natur:[1,4,5],nbacc:1,nc_010473:4,ncbi2tax:[1,2],ncbi:[1,4,5],ncbitaxdir:5,nearbi:5,nearest:[3,4,5],necessari:[1,4,5],necessarili:[1,5],need:[0,1,3,4,5],needleman:1,neg:[4,5],negat:1,neglig:1,neighbor:[3,4,5],neither:[1,5],neq:5,net:[0,1],network:[0,4,5],new_human:4,new_human_snp:4,newer:[0,5],newick:[1,3,4],newick_format:1,newli:5,next:[4,5],ngsparam:0,nichola:1,nicngsrtfgilcipkkpgkypallrvpgagvr:1,nih:[4,5],nirqgsrtfgi:1,nirqgsrtfgifcmpkasgnypallrvpgaggr:1,nirqgsrtfgilcmpkasgnypallrvpgagvr:1,nlm:[4,5],node:[0,1,3,4,5],nohzadeh:[1,5],nois:5,nomenclatur:3,non:[0,1,3,4],non_snp_roc:5,none:[0,1,4,5],noninfring:1,nonneg:5,nonspecif:1,nor:1,norank:5,normal:[1,2,3,5],normal_:4,normal_map_:4,normal_reads_:4,normalis:5,note:[0,1,4,5],notic:[2,4],notif:0,notion:1,novel:[1,3,4,5],novo:[1,3,5],now:[0,1,4,5],nref:1,nuccor:4,nuclear:5,nucleotid:[1,3,4,5],num:5,number:[0,1,2,5],numer:[1,5],nvrpgsrtygilcmpkkegkypallrvpgagir:1,object:[1,3,4,5],observ:[1,4,5],obtain:[1,4,5],obviat:5,obviou:5,obvious:1,occasion:[1,5],occupi:5,occur:[1,3,4,5],ococ:[1,5],ocof:[1,5],oct:4,off:[1,4,5],offic:3,offspr:4,often:5,old:5,omit:[1,4,5],omni:[4,5],onc:[1,4,5],ondov:1,one:[0,1,3,4,5],ones:[4,5],onli:[0,1,3,4],onlin:[1,3,5],onto:5,open:[1,3,5],openjdk:1,oper:[0,1,3,5],oppos:4,opt:0,optic:5,optim:[1,2,5],option:[0,1,2,3,5],oracl:1,order:[1,3,4,5],ordinari:5,ordinarili:5,org:[1,4,5],organ:[0,1,3,5],orient:[1,4,5],origin:[1,3,4,5],orl:5,orp:5,other:[0,1,3,4,5],otherwis:[0,1,4,5],our:[1,3,4,5],out:[1,4,5],output:[0,2,4],output_readgroup_id:5,outset:5,outsid:[1,4,5],over:[1,3,4,5],overal:[3,4,5],overlai:5,overlap:[2,4,5],overrid:[1,3,5],overridden:[1,3,5],overview:[2,4],overwrit:5,own:[0,1,4,5],owner:1,ownership:3,pac_bio:5,pacbio:[1,5],pacif:5,packag:[3,5],pad:5,pai:0,pair:[1,3,4],pairwis:5,palett:5,pane:5,par1:1,par2:1,par:[1,4],parallel:[0,2,4,5],paramet:[0,1,3,4,5],parent:[1,4,5],parentag:5,parid:1,parkwai:1,pars:4,parseint:5,part:[1,4,5],parti:[1,4,5],partial:5,particular:[1,3,4,5],particularli:[4,5],partit:[4,5],partition1:4,partition2:4,partition3:4,pass:[1,5],past:[1,5],pat:[1,4,5],patent:[1,3,5],patern:[1,5],path:[0,1,4,5],pathwai:3,patient:4,pattern:4,pca:[1,4],pcr:5,pdf:[1,3,4,5],ped:[2,3,4,5],ped_vcf_head:5,pedfilt:[1,2],pedigre:[2,5],pedsamplesim:[1,2],pedstat:[1,2,4],peel:5,penal:5,penalti:[1,5],pend:[1,5],pentaploid:1,per:[0,1,3,4,5],percent:[1,5],percentag:[1,3,5],perform:[1,2,3],perl:5,perman:5,permiss:[0,1,5],permit:[1,3,4,5],person1:5,person2:5,person3:5,person:[1,3],persona:5,personb:5,pertain:4,petrim:2,pf3:5,pflow:0,pfread:0,pftemplat:0,pgm:4,phase2_reference_assembly_sequ:4,phase:[1,3,4,5],phen:[1,4,5],phenotyp:[1,5],phillippi:1,phred:[1,5],phylogenet:[1,5],phyloxml:[1,3,4],phylum:[1,5],physic:1,pick:5,pie:[1,4,5],piec:3,pielou:1,pileup:[3,5],pipelin:[0,1,2,4],place:[1,3,4,5],placement:[3,5],plain:5,plan:[1,2,3,4],plant:[1,3],plasmid:1,platform:[1,3,4,5],platinum:4,platinumgenom:4,plausibl:5,pleas:[1,3,5],plink:1,ploidi:[1,4],plot:[1,3,4,5],plu:[1,3,5],pnext:[1,5],png:[4,5],pngu:1,point:[1,4,5],poisson:5,polymorph:[1,3,5],polymutt2:1,polyploid:[1,4],poor:[1,3,4,5],pop:5,pop_vari:4,popsim:[2,3],popul:[1,2,3],popular:5,population_prior:4,popvar:5,port:[0,5],portabl:[4,5],portion:1,pos:[1,4,5],posit:[1,3,4],possess:4,possibl:[0,1,4,5],post:[1,3,5],posterior:[1,3,5],potenti:[1,4,5],power:5,ppb:1,practic:[1,4,5],pragmat:5,pre:[1,4,5],prebuilt:4,preced:1,precis:1,predict:[1,3,4,5],predictor:5,prefer:[3,4,5],prefix:5,prepar:[0,1,2,3,5],preprocess:5,prerequisit:[4,5],presenc:[3,4,5],present:[1,3,4,5],preserv:5,presum:5,prevent:[1,4,5],previou:[1,4,5],previous:5,primari:[4,5],primarili:[1,4,5],princip:[1,3,4,5],principl:5,print:[4,5],prior:[1,2,3],prioriti:5,privileg:[0,1,3],pro:4,probabl:[1,3,4,5],probe:5,problem:[0,1,5],problemat:5,procedur:[4,5],proceed:1,process:[0,2,4,5],processor:[0,1,3,5],procur:1,produc:[1,2,3,5],product:[0,1,2,3,5],profit:1,program:[1,3,4,5],progress:[0,2,3,5],project:[1,4,5],promot:1,prompt:[1,3,5],proper:[1,5],properli:1,properti:[0,1,5],proport:[1,4,5],proprietari:1,protein:[1,2],protein_db:5,proteobacteria:5,prototyp:1,prove:4,provid:[0,1,3,4,5],proxi:0,prune:5,pseudo:1,pseudoautosom:[1,4],pub:5,publish:1,pur:1,purcel:1,purchas:3,pure:5,puriti:1,purpos:[1,3,4,5],push:[1,5],put:[1,3,4,5],qname:[1,5],quad:3,qual:[4,5],qualiti:[0,1,3,4],qualti:5,quantiti:4,quarantin:[1,3],queri:[1,3,5],query_seq:5,querylength:1,question:[1,3,5],quick:[1,2,5],quickli:4,quit:5,quot:1,r121336:4,r_2011_07_19_20_05_38_user_b14:4,rack:[0,3],rais:[4,5],ram:[0,1,3,4,5],random:[4,5],randomli:5,rang:[1,3,4,5],rank:[1,5],ranknam:1,rapid:3,rate:[1,3,5],rather:[1,3,4,5],rathod:[1,5],ratio:[1,3,4,5],raw:[1,4,5],rce:1,rcequiv:1,rdefault:5,reach:[1,5],read:[0,2],read_data:1,readabl:[3,5],readcount:5,readgroup1:5,readgroup:[1,5],readi:[4,5],readm:[2,3],reads_1:4,reads_2:4,reads_sd:5,reads_shuffl:5,readsim:[2,3],readsimev:2,real:[0,1,3,4,5],realign:1,realist:0,realiti:4,realli:5,realtimegenom:[1,3,4,5],reason:[1,4,5],recal:[4,5],recalibr:[4,5],receiv:[1,4,5],receiver_operating_characterist:5,recip:4,recogn:[4,5],recombin:5,recommend:[1,3,4,5],recomput:1,reconstruct:1,record:[0,2,3,4],recreat:5,redirect:5,redistribut:1,reduc:[1,3,4,5],reduct:[1,5],redund:[4,5],redwood:1,ref:[4,5],refer:[0,2,3],referenc:1,refin:5,reflect:[1,5],refseq:4,regard:[1,3,4,5],regardless:[1,5],regener:5,region:[2,3,4],regist:1,registr:4,regular:5,reject:5,rel:[1,4,5],relabel:[1,5],relat:[1,3,4,5],related:4,relationship:[1,2,4,5],relax:5,releas:[1,3,5],relev:[4,5],reli:5,reliabl:[3,5],remain:[1,5],remap:4,remot:1,remov:[1,3,4,5],renam:[4,5],reorder:5,repeat:[1,4,5],repetit:5,replac:[1,4,5],replic:5,report:[0,1,2,3,5],repres:[1,3,4,5],represent:[1,4,5],reproduc:1,request:0,requir:[0,1,3,4,5],requisit:5,rerun:[4,5],rescor:[1,4],research:[1,3,4,5],reserv:1,reset:5,resid:[4,5],residu:[1,4,5],resolut:5,resolv:5,resourc:4,respect:[1,3,4],restor:5,restrict:[1,3,4,5],result:[0,2,3,4,5],retain:[1,4,5],retriev:[1,3,5],reus:4,reusabl:4,revers:[1,5],review:[2,3],rg1:5,rgstat:[1,4,5],richard:[1,5],right:[1,3,4,5],right_fq:4,rightarrow:5,rname:1,rnext:[1,5],roch:1,rocplot:2,root:[1,3,4,5],ross:[1,5],rough:5,roughli:5,row:4,rpb:[1,4],rpm:[0,3],rs23987382:1,rsh:1,rtg:[0,2],rtg_default_thread:0,rtg_jar:0,rtg_java:0,rtg_java_opt:0,rtg_mem:[0,1,3,5],rtg_models_dir:0,rtg_proxi:0,rtg_references_dir:[0,5],rtg_talk_back:0,rtg_talkback:0,rtg_taxonomi:5,rtg_usag:0,rtg_usage_dir:0,rtg_usage_host:0,rtg_usage_opt:0,rtgcustom:5,rtgv2:1,rule:0,run:[1,2,3,5],runtim:[0,1],s12_r1:5,s12_r2:5,s12_trim:5,s12_trimmed_r1:5,s_sampl:5,sahar:[1,5],sai:5,sam2bam:2,sam:[2,4,5],same:[0,1,3,4],samfil:5,sammerg:2,sampl:[0,2],sample1:[4,5],sample1_1:4,sample2:4,sample2_2:4,sample3:4,sample4:4,sample5:4,sample_1:4,sample_2:4,sample_id:4,sample_na12878:4,sample_nam:5,sampleread:5,samplereadssdf:5,samplereplai:[2,3],samplesim:[2,3],samrenam:[1,2,3],samstat:[2,4],samtool:[1,3,4,5],samv1:[1,3],sanger:[4,5],sars_coronaviru:5,sars_sample1:5,sars_sample2:5,satisfi:[1,5],save:[0,1,5],sbp:[1,4],scale:[0,1,3,5],scan:[3,5],scenario:[3,4,5],scheme:5,scienc:1,scont:5,score:[0,2,3,5],screen:[1,4,5],script:[0,1,3,4],sdf2cg:2,sdf2fasta:[2,3],sdf2fastq:[2,3],sdf2sam:2,sdf:[1,3,4,5],sdf_proteinref:5,sdf_read:5,sdfsplit:[2,3],sdfstat:[1,2,4],sdfsubseq:2,sdfsubset:2,sean:[1,5],search:[1,2],search_out:5,second:[0,1,3,4,5],secondari:5,secondli:5,section:[1,3,4,5],secur:1,see:[1,3,4,5],seed:5,seem:1,seen:5,segment:[1,3,4,5],segreg:4,select:[1,3,4,5],self:3,sell:1,semant:[1,4,5],semi:[1,3,5],semicolon:1,send:0,sens:[1,5],sensit:[0,2,4],sensitivity_and_specif:5,sent:0,sep:4,separ:[0,1,3,4,5],seq:[1,4],seqdata0:3,seqpointer0:3,seqs_for_alignment_pipelin:4,sequenc:[1,2,5],sequence_nam:5,sequenceindex0:3,seri:[3,5],serial:0,server:[0,1,3,4,5],servic:[1,5],session:5,set:[0,1,2,3,5],setup:5,sever:[0,1,3,4,5],sex:[1,2,3,5],shadow:5,shall:1,shannon:1,shannon_index:1,shape:1,share:[0,1,5],shell:[1,4,5],shift:[1,5],shore:1,shorter:[3,5],should:[1,4,5],show:[1,3,4,5],shown:[1,3,4,5],shtml:1,shuffl:5,side:[1,5],sidepan:5,sign:4,signal:[1,5],signific:[3,5],significantli:3,sim:5,sim_read:5,simil_out:5,similar:[2,3],similarli:[3,4,5],simpl:[0,1,3,4],simpli:[4,5],simpson:1,simul:[1,2,3],simulatedsequence1:1,simulatedsequencen:5,simultan:[1,4,5],sinc:[1,4,5],singapor:[1,5],singl:[1,2,3,5],site:[1,2,3,5],situat:[1,3,4,5],six:[1,3],size:[0,1,3,4,5],skew:5,skip:[1,5],slice:5,slider:5,slightli:[1,5],slow:[4,5],sm_base:1,sm_father:1,sm_mother:1,sm_normal:4,sm_son:1,sm_tumor:[1,4],small:[2,3,4,5],smaller:[0,1,3,4,5],smith:1,smooth:[1,3,4,5],snp1:5,snp2:5,snp:[1,2,4],snp_chr5:5,snp_roc:5,snp_sample_na12878:4,snp_sample_na12878_chr:4,snp_sample_na12891:4,snps_biallel:5,snps_cov5:5,soft:[1,5],softwar:[0,1,2,4,5],solari:3,sole:5,solexa:[1,4,5],solut:[3,5],som:5,somat:[1,2],somatic_out:4,some:[0,1,3,4,5],someth:[1,5],sometim:[3,5],somewhat:[4,5],somewher:5,son1:5,son2:5,son:[3,4,5],son_gt:5,sort:[1,3,4,5],sourc:[1,3,4,5],sourceforg:1,soviet:1,sp_out:5,space:[1,3,4,5],span:5,spars:5,speak:5,spec:[1,3,4],speci:[2,3],special:[1,4,5],specialist:3,species_even:1,species_genom:5,species_result:4,specif:[0,1,2,3,5],specifi:[0,1,3,4,5],speed:[0,3,5],sph:1,split:[1,4],split_read:5,spot:5,spotti:4,spread:5,spreadsheet:[3,4,5],spuriou:5,sqrt:5,squar:5,srr002978:1,srr005490:5,ssc:[1,4,5],stage:[1,4,5],stand:1,standard:[0,1,2,4,5],start:[0,2,4,5],startup:5,stat:[1,5],statist:[1,2,3,5],statu:[0,1,4,5],stdin:5,stdout:5,step:[1,3,4,5],still:[1,4,5],storag:[0,3],store:[0,1,3,4,5],straight:[1,5],strain:[3,4,5],strain_map:5,strain_read:5,strain_ref:5,strand:[1,4],strategi:[4,5],stratifi:5,streamlin:4,strength:[1,4,5],stretch:5,strict:[1,5],stricter:5,strictli:5,string:5,stringenc:5,strl:1,strong:[1,5],strongli:4,stru:1,structur:[1,2,3,5],stuart:[1,5],studi:5,style:5,sub:[4,5],subclass:5,subdirectori:[1,4,5],subfamili:5,subgenu:5,subgroup:5,subject:[1,3,5],sublicens:1,submiss:0,submit:0,subord:5,subphylum:5,subsampl:5,subscrib:1,subsequ:[1,3,4,5],subset:[3,5],subset_read:5,subspeci:5,substanti:1,substitut:[1,3,4,5],subtleti:5,subtli:5,subtre:5,succeed:0,success:[1,3,5],successfulli:[3,5],suffic:1,suffici:[1,4,5],suffix:0,suggest:[1,3,4,5],suit:[3,4],suitabl:[1,4,5],sum:[1,5],sum_:5,summar:5,summari:[1,3,4,5],superkingdom:[1,5],superphylum:5,suppli:[0,1,3,4,5],support:[0,1,2,4,5],suppress:5,sure:[3,4],suspect:5,sv_bayesian:[1,4,5],sv_interest:[1,5],sv_out:5,sv_sample_na12878:4,sv_simpl:1,svdecompos:2,svg:5,svprep:2,svtype:[1,5],sweep:5,symbol:[3,4,5],synonym:5,synopsi:5,syntax:[2,3],synthet:[3,5],system:[0,1,3,4,5],tab:[1,3,4,5],tabix:[1,4,5],tabl:[1,3,4,5],tabular:[4,5],tacttactttcttcttacttatgtggtaataagctactcggttgggca:1,tag:[1,5],take:[1,3,4,5],taken:[1,3,4,5],talkback:2,tandem:[1,5],tar:5,target:[1,4,5],task:[1,2,3,5],taxa:[1,3],taxdump:5,taxfilt:[1,2],taxid:1,taxon:[1,2,5],taxonom:[2,3,5],taxonomi:[2,4,5],taxonomy_lookup:1,taxstat:[1,2],tbi:4,tcca:1,tcctcca:1,tccttca:1,tcount:5,tdrwgsrfygvlcvpkkegkypallrvpgagir:1,team:5,technic:[2,4,5],technolog:[1,3,4,5],tell:5,temp:5,tempdir:[4,5],templat:[1,5],temporari:[0,4,5],temporarili:5,ten:5,term:[1,5],termin:[0,1,3,4,5],terminolog:5,test:[0,2,3,4,5],tetraploid:[1,5],text:[0,1,3,4,5],textual:5,tgacgcctctgctcttgcaagtcnttcacattca:1,tgagctgtgtt:1,tggaaggccag:1,than:[1,3,4,5],thei:[0,1,4,5],them:[1,3,4,5],themselv:[3,4,5],theori:1,thereof:1,thi:[0,1,3,4,5],thing:4,think:5,third:[1,3,4,5],thirdli:5,thorough:[1,5],those:[1,3,4,5],though:0,thread:[0,1,5],three:[1,4,5],threshold:[0,1,3,4,5],through:[1,3,4,5],throughout:4,throughput:[1,3,4,5],thu:[1,4,5],thumb:0,tid:[1,4,5],tie:1,tied:4,time:[1,2,3,4,5],tip:[1,5],tissu:4,titl:5,tlen:[4,5],tmp:[4,5],tofix:5,togeth:[1,3,4,5],toler:5,too:[1,3,5],tool:[1,2,3,5],top:[1,4,5],topequ:5,topn:[0,5],torrent:[1,2],tort:1,total:[1,3,4,5],totalmemori:0,tpl:[1,4,5],tpng:[4,5],trace:4,track:[1,4,5],trade:[4,5],trademark:1,tradeoff:5,tradit:5,traffic:[1,3],trail:5,train:[0,2,5],transbord:5,transform:[1,3,5],transit:5,translat:[1,2,3,5],transvers:5,trap:0,tre:[1,4],treat:[1,5],tree:[1,3,4,5],triallel:5,tribe:5,trigg:[1,5],trigger:5,trim:4,trio:[4,5],trio_map:5,trio_vari:4,triploid:1,trivial:5,truncat:[0,5],truth:[4,5],truthi:5,tsm:[1,4,5],tsv:[1,3,4,5],tta:1,ttgg:5,tttaaat:1,tttg:5,tttgcgcgcttgcgcgttt:5,tttt:5,tttttttttctttctttctttctttctttctttctttctttctttctttctttc:5,tumor:[2,3,5],tumor_:4,tumor_map_:4,tumor_reads_:4,tumoronli:[1,2,3,4],tumoronly_out:4,tune:[2,4,5],turn:[1,4,5],two:[0,1,3,4,5],txt:[0,2,3,4,5],type:[1,3,4,5],typic:[0,1,3,4,5],ucsc:[1,4],ucsc_id:4,umich:1,unaffect:[1,5],unalign:5,unambigu:5,unavail:[4,5],unchang:5,unclassifi:1,uncompress:5,undecid:5,undefin:[1,5],under:[1,5],undergo:5,undergon:3,underli:0,underneath:[1,5],undescrib:1,undesir:[4,5],undo:5,unduli:5,unexpect:[4,5],unfilt:5,unfiltered_fin:5,unflatten:5,uniform:[1,5],uniformli:5,uninform:5,union:5,uniqu:[0,1,3,4,5],unit:[1,4,5],unix:[0,3,5],unknown:[1,4,5],unless:[1,4,5],unlik:5,unmap:[1,3,4,5],unmat:[1,3,4,5],unmerg:5,unnam:5,unnecessari:4,unpair:[1,5],unphas:5,unplac:[1,5],unpreced:3,unrel:[3,4],unreli:1,unset:[1,5],unsign:[1,3],until:1,untransl:[1,3,5],unus:5,unusu:4,unwant:3,unwieldi:[1,4],unzip:[1,3],uon:5,updat:[1,3,4,5],upload:1,upon:4,upper:[1,3,5],url:[0,1],usa:1,usag:[1,2,3,5],usageserv:[0,2],use:[0,1,2,3,5],used:[0,1,3,4,5],useful:[0,1,3,5],user:[1,2,3,4,5],usernam:0,uses:[0,1,3,4,5],using:[0,2,3],usr:[1,3],usual:[1,3,5],utah:4,util:[1,2,4],vaf1:[1,5],vaf:[1,5],valid:[1,3,5],valu:[0,1,3,4,5],valuabl:5,vari:[0,1,3,4,5],variabl:[0,1,3,5],varianc:5,variant:2,variat:[0,1,2,5],varieti:[3,4,5],variou:[1,3,5],vcf2rocplot:2,vcf:[2,3,4],vcfannot:[2,4],vcfdecompos:2,vcfeval:[2,4],vcffilter:[1,2,4],vcfmerg:[2,4],vcfsplit:2,vcfstat:[2,4],vcfsubset:[2,4],vcfv4:[1,3,4],vega:[1,5],vendor:[4,5],verbos:5,veri:[0,1,3,4,5],verif:5,verifi:[1,3,4,5],version1:1,version:[0,1,2,3,4],versu:1,via:[0,1,3,4,5],view:[1,2,3,5],viewer:[3,5],viewpoint:5,violat:5,virtual:[1,3,5],visibl:3,visit:1,visual:[0,1,3,4,5],vof:4,vol1:4,volum:3,vulner:4,wai:[1,4,5],wall:[1,3,4],want:[4,5],ware:[1,5],warn:[4,5],warranti:1,washington:1,waterman:1,web:[4,5],websit:[1,4,5],wedg:[1,5],weight:[4,5],weighted_roc:5,weinberg:[1,5],well:[1,3,4,5],were:[1,5],wget:5,wgs:[4,5],what:[1,4,5],when:[0,1,3,4,5],whenev:[3,5],where:[0,1,3,4,5],wherea:[4,5],whether:[0,1,4,5],which:[0,1,3,4,5],whichev:[3,5],white:1,whole:[1,4,5],whom:1,whose:5,why:3,wide:[3,4,5],widget:5,width:5,wiki:[1,5],wikipedia:[1,5],wild:[1,5],window:[0,1,3,5],wise:4,wish:[0,4,5],within:[0,1,3,4,5],without:[0,1,3,5],word:[1,3,4,5],work:[0,1,4,5],workflow:[4,5],workspac:1,would:[1,3,4,5],wrapper:[1,3],write:[0,1,3,4,5],written:[0,1,3,4,5],wunsch:1,www:[1,4,5],x86_64:0,xattr:[1,3],xmax:5,xmin:5,xml:[1,4],xrx:[1,4],year:5,yes:[1,4],yet:[3,5],yield:[3,4,5],ymax:5,ymin:5,you:[0,1,3,4,5],your:[0,1,3,4,5],yourself:5,ypallrvpgag:1,yyyi:0,zcat:[4,5],zealand:[1,5],zero:[1,4,5],zip:[1,3],zless:4,zook:5,zoom:5,zp_03299218:1,zp_03678041:1,zp_05285664:1,zp_05759216:1,zxf:5,zygos:[1,4,5]},titles:["Administration & Capacity Planning","Appendix","Table Of Contents","Overview","RTG product usage - baseline progressions","RTG Command Reference"],titleterms:{"function":[1,3,5],POS:1,Use:4,Using:[1,4],abund:3,access:1,adapt:5,addit:[1,5],addpacbio:5,administr:0,advanc:[0,5],against:4,align:[1,3],allel:5,alt:1,altern:0,analysi:3,annot:5,api:1,appendix:1,approach:1,assembl:5,assist:3,aview:5,avr:4,avrbuild:5,avrpredict:5,avrstat:5,bacteri:4,bam:[1,3],base:5,baselin:4,bed:1,benchmark:[3,5],bgzip:5,bndeval:5,breakdown:3,build:4,calibr:5,call:4,caller:3,cancer:4,capac:0,cg2sdf:5,cgmap:[1,5],cgsim:5,check:4,checkminvers:1,childsim:5,chrom:1,chrstat:5,cli:5,cnv:[3,5],color:0,column:5,combin:5,command:[0,1,3,5],common:5,compar:5,comparison:5,complex:3,composit:5,comput:1,configur:0,consensu:5,construct:5,contamin:[3,4],content:[1,2],copi:[3,4],coverag:[1,3,4,5],creat:[3,4],curv:5,custom:5,data:[3,4,5],databas:4,decomposit:5,denovosim:5,deploy:3,descript:[1,3],detect:[3,4,5],diploid:5,directori:1,discord:[1,4,5],distribut:[1,5],dna:4,enclos:1,end:[1,5],ensurefilterhead:1,ensureformathead:1,ensureinfohead:1,error:1,estim:4,evalu:[4,5],exampl:5,except:0,expr:5,express:5,extens:1,extract:5,famili:[4,5],fastqtrim:5,field:1,file:[0,1,3,4],filenam:1,filter:[1,3,4,5],filter_header_str:1,find:4,fly:5,format:[1,3,4,5],format_field:1,format_header_str:1,frequenc:4,fromb:1,fromvcf:1,gap:1,gener:4,genet:1,genom:[1,4,5],genomesim:5,graph:5,group:[1,4],gui:5,haploid:4,hapmap:4,has:5,hashdist:5,header:1,help:5,highlight:0,human:4,indel:[3,5],index:[1,5],info:1,info_field:1,info_header_str:1,inform:[1,4],input:[1,3],instal:[0,3,4],instruct:3,interact:5,interfac:5,introduct:3,ion:4,javascript:[1,5],keep:5,licens:[3,5],line:[0,5],lineag:5,log:0,lookup:1,machin:0,manag:[0,3,4],map:[1,3,4,5],mapf:5,mapp:[1,5],mapx:[1,5],mapxrenam:5,match:5,mendelian:[3,5],merg:5,meta:5,metagenom:[3,4,5],mode:[4,5],model:4,modif:1,multi:0,multipl:0,name:4,ncbi2tax:5,non:5,normal:4,notic:1,number:[3,4],onli:5,optim:[0,3],option:4,output:[1,3,5],overlap:1,overview:3,pair:5,parallel:[1,3],ped:1,pedfilt:5,pedigre:[1,3,4],pedsamplesim:5,pedstat:5,perform:[0,4,5],petrim:5,pipelin:[3,5],plan:0,ploidi:5,popsim:5,popul:[4,5],posit:5,precis:5,prepar:4,preset:5,print:1,prior:[4,5],process:[1,3],produc:4,product:4,progress:4,protein:[3,4,5],qual:1,qualiti:5,quick:3,read:[1,3,4,5],readm:1,readsim:5,readsimev:5,record:[1,5],ref:1,refer:[1,4,5],region:[1,5],regions_object:1,relationship:3,report:4,rescor:5,respect:5,result:1,review:4,roc:5,rocplot:5,rtg:[1,3,4,5],rtg_minimum_vers:1,run:[0,4],sam2bam:5,sam:[1,3],same:5,sammerg:5,sampl:[1,3,4,5],sample_nam:1,samplereplai:5,samplesim:5,samrenam:5,samstat:5,score:[1,4],script:5,sdf2cg:5,sdf2fasta:5,sdf2fastq:5,sdf2sam:5,sdfsplit:5,sdfstat:5,sdfsubseq:5,sdfsubset:5,search:[3,4,5],sensit:[3,5],sequenc:[3,4],set:4,sex:4,similar:[1,4,5],simpl:5,simul:5,singl:[0,4],site:4,small:1,snp:[3,5],softwar:3,somat:[3,4,5],speci:[1,4,5],specif:4,split:5,squash:5,standard:3,start:[1,3],statist:4,stratif:5,string:1,structur:4,support:3,svdecompos:5,svprep:5,syntax:5,tabl:2,talkback:0,task:4,taxfilt:5,taxon:3,taxonom:1,taxonomi:1,taxstat:5,technic:[1,3],test:1,time:0,tool:4,torrent:4,train:4,translat:4,trim:5,tumor:4,tumoronli:5,tune:3,txt:1,usag:[0,4],usageserv:5,use:4,user:0,using:[1,4,5],util:[3,5],variant:[1,3,4,5],variat:[3,4],vcf2rocplot:5,vcf:[1,5],vcfannot:5,vcfdecompos:5,vcfeval:5,vcffilter:5,vcfmerg:5,vcfsplit:5,vcfstat:5,vcfsubset:5,version:5,versu:5,view:4}}) \ No newline at end of file