Skip to content
Snippets Groups Projects
Commit 54cf991e authored by Aaron's avatar Aaron
Browse files

[DOCS] update maskfasta docs

parent 8aecb36f
No related branches found
No related tags found
No related merge requests found
docs/content/images/tool-glyphs/maskfasta-glyph.png

14.2 KiB

<?xml version="1.0" encoding="utf-8"?>
<!-- Generator: Adobe Illustrator 16.0.0, SVG Export Plug-In . SVG Version: 6.00 Build 0) -->
<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
<svg version="1.1" id="Layer_1" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" x="0px" y="0px"
width="750.667px" height="191.334px" viewBox="0 0 750.667 191.334" enable-background="new 0 0 750.667 191.334"
xml:space="preserve">
<g opacity="0.7">
<g>
<path fill="none" stroke="#FBB040" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M273.127,72.49
c0.007,0.136,8.964-0.571,8.969-0.471c0.005,0.098-7.93,2.58-7.924,2.705c0.032,0.598,58.285-3.833,58.326-3.057
c0.045,0.865-58.719,6.104-58.684,6.77c0.054,1.034,86.797-5.596,86.852-4.552c0.059,1.125-88.677,7.225-88.625,8.223
c0.03,0.581,90.881-6.045,90.948-4.766c0.059,1.118-91.204,6.992-91.163,7.782c0.045,0.86,90.71-5.247,90.736-4.755
c0.06,1.138-90.417,6.129-90.369,7.031c0.059,1.128,90.663-5.804,90.719-4.755c0.035,0.684-90.6,6.116-90.534,7.389
c0.032,0.601,89.88-5.89,89.942-4.714c0.039,0.733-91.667,5.467-91.596,6.822c0.061,1.165,93.512-6.048,93.572-4.903
c0.062,1.183-92.337,6.478-92.271,7.727c0.033,0.623,90.887-5.547,90.928-4.765c0.05,0.947-89.165,5.725-89.095,7.063
c0.046,0.894,87.114-5.203,87.147-4.566c0.042,0.8-90.568,6.679-90.538,7.263c0.065,1.234,93.561-6.028,93.62-4.906
c0.026,0.498-89.915,7.204-89.866,8.146c0.068,1.297,87.103-5.241,87.138-4.566c0.035,0.655-50.662,4.873-50.642,5.258
c0.035,0.656,51.69-3.254,51.72-2.71c0.022,0.435-30.99,3.249-30.967,3.689c0.019,0.355,29.17-1.957,29.192-1.529"/>
<g>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M282.664,72.514
c0.017,0.314,23.975-1.479,23.987-1.257c0.014,0.271,33.434,0.508,33.457,0.961c0.005,0.1,13.979-0.854,13.984-0.733
c0.002,0.042,6.559,3.425,6.562,3.492c0,0.01,1.502-0.093,1.502-0.079c0.002,0.021-1.024,3.997-1.022,4.027
c0,0.01,2.646-0.148,2.646-0.139c0.003,0.051-2.999,2.517-2.998,2.547c0.001,0.011,3.807-0.213,3.808-0.2
c0.003,0.06-2.803,3.427-2.801,3.469c0.001,0.013,2.108-0.123,2.109-0.11c0.003,0.054-2.039,3.023-2.036,3.067
c0,0.009,0.938-0.058,0.938-0.049c0.001,0.021-2.342,2.568-2.34,2.607c0,0.008,4.112-0.229,4.113-0.216
c0.001,0.024-3.307,3.432-3.303,3.494c0,0.006,0.592-0.035,0.593-0.03c0.001,0.031,0.014,3.328,0.016,3.368
c0.001,0.01,0.937-0.054,0.937-0.049c0.002,0.032-0.572,2.432-0.571,2.454c0,0.007,2.141-0.127,2.142-0.112
c0.003,0.055-2.499,3.425-2.496,3.48c0,0.008,0.936-0.061,0.936-0.049"/>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M272.657,72.021
c0.007,0.135,8.962-0.571,8.968-0.47c0.005,0.097-7.929,2.58-7.922,2.703c0,0.009,0.033-0.013,0.034-0.001
c0.003,0.062-1.846,3.743-1.844,3.791c0,0.011,0.885-0.057,0.885-0.047c0.003,0.049-1.208,3.599-1.206,3.643
c0,0.005,1.891-0.112,1.892-0.1c0.002,0.046-2.108,3.083-2.106,3.115c0,0.009,1.681-0.093,1.681-0.089
c0.002,0.034-1.316,2.338-1.314,2.364c0,0.012,1.663-0.097,1.664-0.087c0.001,0.023-1.48,2.678-1.478,2.721
c0,0.007,0.886-0.059,0.887-0.047c0.001,0.027-2.544,2.107-2.542,2.156c0,0.012,4.517-0.249,4.517-0.237
c0.003,0.057-3.22,3.001-3.217,3.061c0,0.006,1.874-0.106,1.874-0.099c0.001,0.031-1.539,2.433-1.536,2.476
c0,0.009,0.905-0.053,0.905-0.047c0.002,0.034-2.801,2.64-2.8,2.665c0.001,0.012,4.566-0.251,4.567-0.239
c0.001,0.024-2.675,3.529-2.672,3.576c0.001,0.013,0.911-0.055,0.911-0.048c0.001,0.035,0.953,2.533,0.954,2.554
c0.023,0.438,33.979-2.146,33.998-1.781c0.009,0.175,12.479,1.235,12.488,1.412c0.007,0.126,10.498-0.701,10.505-0.55
c0.015,0.265,20.686,0.819,20.701,1.104c0.009,0.168,13.142-0.786,13.146-0.689"/>
</g>
</g>
</g>
<g opacity="0.7">
<g>
<path fill="none" stroke="#FBB040" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M173.127,72.491
c0.007,0.135,8.971-0.572,8.976-0.471c0.005,0.097-7.937,2.58-7.931,2.704c0.026,0.495,48.058-3.162,48.092-2.521
c0.038,0.715-48.479,5.683-48.449,6.234c0.029,0.562,45.824-2.972,45.854-2.403c0.032,0.606-47.655,5.535-47.627,6.075
c0.017,0.315,49.913-3.313,49.949-2.618c0.032,0.617-50.187,5.198-50.164,5.633c0.024,0.468,49.724-2.874,49.738-2.606
c0.033,0.623-49.397,4.389-49.371,4.882c0.032,0.615,49.69-3.176,49.72-2.605c0.02,0.375-49.571,4.542-49.535,5.239
c0.017,0.327,48.91-3.204,48.943-2.565c0.021,0.406-50.637,3.924-50.598,4.673c0.033,0.634,52.54-3.377,52.573-2.755
c0.035,0.659-51.309,4.883-51.272,5.579c0.018,0.339,49.907-3.042,49.929-2.617c0.027,0.513-48.134,4.192-48.096,4.916
c0.025,0.486,46.131-2.765,46.149-2.419c0.023,0.439-49.556,4.794-49.539,5.115c0.035,0.671,52.59-3.369,52.622-2.758
c0.014,0.271-48.895,5.483-48.868,5.996c0.037,0.707,46.121-2.785,46.14-2.418c0.018,0.338-25.958,3.766-25.948,3.964
c0.019,0.354,27.011-1.708,27.026-1.416"/>
<g>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M182.453,72.525
c0.012,0.226,17.034-1.053,17.042-0.893c0.009,0.176,21.632,1.287,21.647,1.58c0,0.007,1.096-0.066,1.097-0.058
c0.001,0.027-2.584,3.928-2.583,3.971c0,0.009,1.503-0.093,1.503-0.079c0.001,0.021-1.025,3.998-1.023,4.027
c0,0.01,2.647-0.148,2.647-0.139c0.002,0.051-3,2.516-2.998,2.547c0,0.01,3.807-0.212,3.807-0.199
c0.003,0.059-2.802,3.426-2.8,3.468c0.001,0.012,2.108-0.124,2.108-0.111c0.003,0.054-2.038,3.023-2.036,3.068
c0,0.009,0.937-0.058,0.938-0.049c0.001,0.021-2.341,2.568-2.339,2.607c0,0.007,4.112-0.229,4.112-0.216
c0.001,0.024-3.305,3.432-3.302,3.494c0,0.006,0.591-0.036,0.591-0.031c0.001,0.031,0.015,3.329,0.017,3.369
c0,0.009,0.936-0.054,0.936-0.049c0.002,0.032-0.572,2.431-0.57,2.454c0,0.007,2.14-0.126,2.141-0.112
c0.002,0.048-2.499,2.805-2.497,2.853c0,0.008,0.935-0.061,0.935-0.049"/>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M172.657,72.021
c0.007,0.136,9.082-0.579,9.087-0.477c0.005,0.098-8.048,2.584-8.042,2.71c0,0.009,0.033-0.014,0.034-0.002
c0.003,0.062-1.846,3.744-1.844,3.791c0,0.01,0.885-0.057,0.885-0.046c0.003,0.049-1.208,3.599-1.206,3.642
c0,0.006,1.891-0.112,1.892-0.099c0.002,0.046-2.108,3.083-2.106,3.115c0,0.008,1.681-0.093,1.681-0.088
c0.002,0.034-1.315,2.337-1.314,2.364c0,0.011,1.663-0.098,1.663-0.087c0.001,0.023-1.48,2.677-1.478,2.721
c0,0.006,0.886-0.058,0.886-0.046c0.001,0.026-2.544,2.105-2.542,2.155c0,0.012,4.517-0.248,4.517-0.237
c0.003,0.057-3.219,3-3.216,3.061c0,0.006,1.873-0.106,1.873-0.098c0.001,0.031-1.537,2.432-1.535,2.475
c0,0.009,0.904-0.054,0.904-0.047c0.001,0.034-2.8,2.641-2.799,2.666c0.001,0.013,4.566-0.25,4.567-0.239
c0.001,0.025-2.675,3.529-2.672,3.576c0.001,0.013,0.91-0.055,0.911-0.048c0.002,0.035,0.954,2.534,0.955,2.554
c0.013,0.239,17.734-1.128,17.745-0.93c0.01,0.187,13.311,1.18,13.32,1.369c0.01,0.185,15.327-1.026,15.338-0.804"/>
</g>
</g>
</g>
<g opacity="0.7">
<g>
<path fill="none" stroke="#FBB040" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M451.128,72.49
c0.02,0.367,25.376-1.606,25.391-1.331c0.015,0.284-24.365,3.2-24.346,3.564c0.029,0.566,55.081-3.622,55.12-2.889
c0.042,0.818-55.511,5.972-55.478,6.602c0.051,0.977,81.801-5.276,81.852-4.29c0.057,1.062-83.674,7.018-83.624,7.961
c0.028,0.547,85.883-5.712,85.946-4.504c0.056,1.057-86.201,6.773-86.162,7.52c0.043,0.812,85.713-4.958,85.737-4.493
c0.056,1.075-85.415,5.917-85.37,6.769c0.056,1.066,85.666-5.483,85.718-4.492c0.034,0.646-85.595,5.924-85.532,7.126
c0.029,0.567,84.883-5.562,84.941-4.452c0.036,0.693-86.663,5.279-86.596,6.561c0.058,1.1,88.515-5.722,88.571-4.642
c0.059,1.119-87.334,6.284-87.271,7.465c0.03,0.588,85.889-5.242,85.928-4.503c0.047,0.895-84.161,5.539-84.095,6.803
c0.044,0.844,82.116-4.906,82.147-4.305c0.04,0.756-85.566,6.449-85.538,7.001c0.062,1.165,88.565-5.704,88.621-4.645
c0.024,0.47-84.914,6.994-84.867,7.883c0.064,1.226,82.106-4.942,82.14-4.305c0.031,0.601-46.399,4.683-46.381,5.035
c0.031,0.604,47.432-2.988,47.458-2.487c0.02,0.383-27.279,3.107-27.259,3.496c0.017,0.31,25.465-1.708,25.484-1.335"/>
<g>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M475.985,71.71
c0.005,0.098,6.931-0.433,6.935-0.363c0.016,0.297,36.573,0.301,36.599,0.796c0.005,0.095,13.312-0.813,13.318-0.698
c0.002,0.022,0.815,3.758,0.817,3.793c0,0.009,1.502-0.093,1.503-0.079c0.001,0.021-1.024,3.998-1.023,4.028
c0.001,0.009,2.646-0.148,2.646-0.139c0.003,0.051-2.998,2.516-2.996,2.546c0,0.01,3.806-0.212,3.806-0.199
c0.004,0.06-2.802,3.426-2.8,3.469c0.001,0.012,2.108-0.123,2.108-0.11c0.003,0.053-2.038,3.022-2.035,3.067
c0,0.008,0.937-0.058,0.938-0.049c0.001,0.021-2.342,2.568-2.34,2.607c0,0.007,4.112-0.229,4.112-0.216
c0.002,0.024-3.305,3.432-3.302,3.495c0,0.006,0.592-0.036,0.592-0.031c0.002,0.03,0.015,3.328,0.017,3.368
c0,0.01,0.937-0.054,0.937-0.049c0.002,0.032-0.573,2.432-0.572,2.454c0,0.008,2.141-0.126,2.142-0.112
c0.003,0.055-2.498,3.425-2.495,3.48c0.001,0.008,0.935-0.061,0.936-0.049"/>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M450.658,72.021
c0.02,0.371,25.602-1.62,25.616-1.342c0.015,0.287-24.591,3.208-24.571,3.577c0.001,0.009,0.034-0.014,0.034-0.002
c0.004,0.062-1.847,3.744-1.844,3.791c0,0.01,0.886-0.057,0.887-0.046c0.002,0.049-1.209,3.599-1.207,3.642
c0,0.006,1.891-0.112,1.891-0.099c0.003,0.046-2.107,3.083-2.106,3.115c0.001,0.008,1.682-0.093,1.682-0.088
c0.002,0.034-1.316,2.336-1.314,2.364c0,0.011,1.663-0.098,1.663-0.087c0.002,0.023-1.479,2.677-1.478,2.721
c0.001,0.006,0.886-0.058,0.887-0.046c0.001,0.026-2.545,2.105-2.542,2.155c0.001,0.012,4.517-0.248,4.518-0.237
c0.003,0.057-3.22,3-3.217,3.061c0,0.006,1.873-0.106,1.873-0.098c0.002,0.03-1.537,2.432-1.535,2.475
c0,0.009,0.903-0.054,0.904-0.047c0.002,0.034-2.801,2.641-2.799,2.666c0,0.012,4.566-0.251,4.566-0.24
c0.001,0.025-2.674,3.529-2.672,3.576c0.001,0.013,0.909-0.055,0.91-0.048c0.002,0.035,0.954,2.534,0.955,2.554
c0.022,0.431,33.355-2.106,33.374-1.749c0.009,0.168,11.981,1.268,11.99,1.439c0.007,0.123,10.304-0.689,10.312-0.541"/>
</g>
</g>
</g>
<g opacity="0.7">
<g>
<path fill="none" stroke="#FBB040" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M596.127,72.49
c0.008,0.137,9.042-0.576,9.048-0.474c0.005,0.098-8.009,2.583-8.002,2.708c0.028,0.542,52.737-3.469,52.773-2.766
c0.042,0.783-53.163,5.875-53.132,6.479c0.047,0.896,74.806-4.828,74.854-3.922c0.051,0.973-76.671,6.729-76.626,7.594
c0.026,0.502,78.891-5.246,78.949-4.138c0.051,0.972-79.2,6.468-79.164,7.153c0.039,0.746,78.715-4.553,78.737-4.126
c0.052,0.987-78.412,5.62-78.371,6.402c0.052,0.978,78.673-5.035,78.721-4.126c0.03,0.594-78.593,5.656-78.534,6.76
c0.027,0.52,77.889-5.104,77.942-4.085c0.033,0.638-79.66,5.016-79.599,6.193c0.053,1.009,81.521-5.267,81.574-4.275
c0.054,1.03-80.33,6.012-80.273,7.099c0.028,0.54,78.895-4.814,78.93-4.137c0.044,0.82-77.157,5.277-77.097,6.436
c0.041,0.775,75.121-4.488,75.15-3.938c0.036,0.694-78.566,6.127-78.54,6.635c0.056,1.068,81.571-5.25,81.622-4.277
c0.022,0.431-77.911,6.699-77.868,7.516c0.059,1.125,75.11-4.522,75.141-3.938c0.029,0.559-43.198,4.539-43.182,4.867
c0.03,0.564,44.234-2.788,44.259-2.32c0.014,0.252-17.828,2.746-17.814,3.002c0.011,0.193,16.029-1.074,16.042-0.842"/>
<g>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M605.403,72.527
c0.012,0.225,16.865-1.043,16.874-0.885c0.016,0.299,36.771,0.289,36.796,0.787c0.006,0.107,15.157-0.927,15.164-0.795
c0.002,0.026-2.585,3.928-2.583,3.971c0.001,0.009,1.503-0.094,1.504-0.079c0.001,0.021-1.025,3.997-1.023,4.027
c0,0.01,2.647-0.147,2.648-0.139c0.003,0.052-3.001,2.517-3,2.548c0.001,0.01,3.81-0.213,3.811-0.2
c0.003,0.059-2.806,3.426-2.804,3.468c0,0.013,2.111-0.123,2.112-0.11c0.003,0.054-2.042,3.022-2.04,3.067
c0.001,0.01,0.942-0.058,0.942-0.049c0.001,0.021-2.347,2.568-2.345,2.607c0.001,0.008,4.117-0.229,4.118-0.215
c0.001,0.023-3.31,3.432-3.307,3.494c0.001,0.006,0.596-0.037,0.597-0.031c0.001,0.03,0.01,3.328,0.012,3.369
c0.001,0.009,0.941-0.055,0.942-0.05c0.001,0.032-0.579,2.432-0.577,2.454c0,0.008,2.146-0.127,2.146-0.113
c0.003,0.055-2.504,3.426-2.502,3.48c0.001,0.009,0.942-0.061,0.942-0.049"/>
<path fill="none" stroke="#6D6E71" stroke-width="2" stroke-linecap="round" stroke-linejoin="round" d="M595.657,72.021
c0.007,0.136,9.04-0.575,9.046-0.474c0.005,0.098-8.008,2.582-8.001,2.707c0,0.01,0.033-0.013,0.034-0.001
c0.003,0.062-1.846,3.743-1.844,3.791c0.001,0.011,0.886-0.057,0.886-0.046c0.003,0.049-1.209,3.599-1.206,3.642
c0,0.005,1.891-0.112,1.892-0.1c0.002,0.046-2.109,3.083-2.107,3.116c0,0.008,1.682-0.094,1.683-0.089
c0.001,0.034-1.316,2.337-1.315,2.364c0.001,0.012,1.664-0.098,1.664-0.088c0.001,0.023-1.481,2.678-1.479,2.722
c0,0.006,0.888-0.059,0.889-0.047c0.001,0.026-2.546,2.106-2.543,2.155c0,0.012,4.518-0.248,4.518-0.236
c0.003,0.057-3.222,3-3.218,3.06c0,0.007,1.875-0.106,1.875-0.099c0.002,0.031-1.539,2.433-1.537,2.477
c0.001,0.009,0.906-0.055,0.906-0.048c0.002,0.034-2.802,2.64-2.801,2.665c0.001,0.013,4.567-0.25,4.568-0.239
c0.001,0.024-2.677,3.529-2.674,3.576c0,0.013,0.912-0.055,0.912-0.048c0.002,0.035,0.952,2.533,0.954,2.555
c0.02,0.389,29.967-1.895,29.983-1.572c0.007,0.119,8.349,1.51,8.354,1.63c0.012,0.224,18.551-1.243,18.564-0.974"/>
</g>
</g>
</g>
<text transform="matrix(1 0 0 1 48.8535 49.0747)" font-family="'MarkerFelt-Thin'" font-size="27">FASTA</text>
<text transform="matrix(1 0 0 1 48.8535 100.2832)" font-family="'MarkerFelt-Thin'" font-size="27">BED</text>
<g>
<g>
<g>
<path fill="none" stroke="#939598" stroke-linecap="round" stroke-linejoin="round" d="M15.006,125.419
c0.002,0.051,4.894-0.303,4.896-0.256c0.016,0.309,21.848,0.838,21.86,1.07c0.005,0.105,19.046-1.254,19.06-0.999
c0.03,0.566,64.768,0.13,64.812,0.983c0.012,0.222,21.327-1.211,21.332-1.118c0.002,0.049,4.058,1.076,4.059,1.102
c0.014,0.26,21.464-1.316,21.474-1.126c0.018,0.341,55.693,0.747,55.715,1.154c0.008,0.152,20.25-1.221,20.258-1.062
c0.008,0.154,10.217,0.854,10.222,0.941c0.009,0.169,17.084-1.13,17.096-0.896c0.001,0.028,4.013,0.914,4.014,0.94
c0.012,0.233,17.182-1.039,17.189-0.9c0.032,0.614,62.001,0.606,62.018,0.924c0.005,0.097,20.679-1.206,20.685-1.084
c0.003,0.054,8.921,0.929,8.928,1.047c0.009,0.168,18.466-1.122,18.474-0.968c0.009,0.173,18.46,0.89,18.468,1.033
c0.014,0.267,18.787-1.246,18.801-0.985c0.04,0.776,52.926,0.217,52.963,0.926c0.012,0.23,20.707-1.257,20.717-1.086
c0.001,0.029,2.084,0.943,2.085,0.964c0.01,0.177,15.982-0.986,15.99-0.838c0.021,0.396,63.085,0.229,63.123,0.971
c0.015,0.271,21.128-1.207,21.134-1.107c0.027,0.524,62.117,0.597,62.146,1.169c0.011,0.19,20.48-1.188,20.487-1.074
c0.011,0.211,17.549,0.837,17.554,0.932c0.008,0.142,17.474-1.12,17.484-0.916c0.002,0.042,2.808,1.039,2.809,1.062
c0.003,0.04,5.692-0.329,5.693-0.299"/>
</g>
</g>
</g>
<text transform="matrix(1 0 0 1 135.5508 46.4077)" font-family="'Monaco'" font-size="21">ACAGACTGGTATGAAGGTGGCCACAATTCAGAAAGAAAAAAGAAGAGC</text>
<text transform="matrix(1 0 0 1 135.5513 160.4082)"><tspan x="0" y="0" font-family="'Monaco'" font-size="21">ACA</tspan><tspan x="37.806" y="0" fill="#BE1E2D" font-family="'Monaco'" font-size="21">NNNN</tspan><tspan x="88.214" y="0" font-family="'Monaco'" font-size="21">GGTA</tspan><tspan x="138.623" y="0" fill="#BE1E2D" font-family="'Monaco'" font-size="21">NNNNNNN</tspan><tspan x="226.836" y="0" font-family="'Monaco'" font-size="21">GGCCACA</tspan><tspan x="315.051" y="0" fill="#BE1E2D" font-family="'Monaco'" font-size="21">NNNNNNN</tspan><tspan x="403.266" y="0" font-family="'Monaco'" font-size="21">AAGAA</tspan><tspan x="466.276" y="0" fill="#BE1E2D" font-family="'Monaco'" font-size="21">NNNNNN</tspan><tspan x="541.888" y="0" font-family="'Monaco'" font-size="21">AGAGC</tspan></text>
<text transform="matrix(1 0 0 1 45.8535 160.4082)" font-family="'MarkerFelt-Thin'" font-size="27">FASTA’</text>
</svg>
###############
*maskfasta*
###############
**maskFastaFromBed** masks sequences in a FASTA file based on intervals defined in a feature file. The
|
.. image:: ../images/tool-glyphs/maskfasta-glyph.png
:width: 600pt
``bedtools maskfasta`` masks sequences in a FASTA file based on intervals defined in a feature file. The
headers in the input FASTA file must exactly match the chromosome column in the feature file. This
may be useful fro creating your own masked genome file based on custom annotations or for masking all
but your target regions when aligning sequence data from a targeted capture experiment.
......@@ -10,61 +18,91 @@ but your target regions when aligning sequence data from a targeted capture expe
==========================================================================
Usage and option summary
==========================================================================
Usage:
::
maskFastaFromBed [OPTIONS] -fi <input FASTA> -bed <BED/GFF/VCF> -fo <output FASTA>
**Usage**
.. code-block:: bash
$ bedtools maskfasta [OPTIONS] -fi <input FASTA> -bed <BED/GFF/VCF> -fo <output FASTA>
NOTE: The input and output FASTA files must be different.
**(or):**
.. code-block:: bash
$ maskFastaFromBed [OPTIONS] -fi <input FASTA> -bed <BED/GFF/VCF> -fo <output FASTA>
=========================== ===============================================================================================================================================================================================================
Option Description
=========================== ===============================================================================================================================================================================================================
**-soft** Soft-mask (that is, convert to lower-case bases) the FASTA sequence. *By default, hard-masking (that is, conversion to Ns) is performed*.
=========================== ===============================================================================================================================================================================================================
.. note::
The input (``-fi``) and output (``-fo``) FASTA files must be different.
=========================== ==========================================================================================================================================
Option Description
=========================== ==========================================================================================================================================
**-soft** Soft-mask (that is, convert to lower-case bases) the FASTA sequence. *By default, hard-masking (that is, conversion to Ns) is performed*.
**-mc** Replace masking character. That is, instead of masking with Ns, use another character.
=========================== ==========================================================================================================================================
==========================================================================
Default behavior
==========================================================================
**maskFastaFromBed** will mask a FASTA file based on the intervals in a BED file. The newly masked
FASTA file is written to the output FASTA file.
**bedtools maskfasta** will mask a FASTA file based on the intervals in a
BED file. The newly masked FASTA file is written to the output FASTA file.
.. code-block:: bash
For example:
::
cat test.fa
$ cat test.fa
>chr1
AAAAAAAACCCCCCCCCCCCCGCTACTGGGGGGGGGGGGGGGGGG
cat test.bed
$ cat test.bed
chr1 5 10
maskFastaFromBed -fi test.fa -bed test.bed -fo test.fa.out
$ bedtools maskfasta -fi test.fa -bed test.bed -fo test.fa.out
cat test.fa.out
$ cat test.fa.out
>chr1
AAAAANNNNNCCCCCCCCCCGCTACTGGGGGGGGGGGGGGGGGG
==========================================================================
Soft-masking the FASTA file.
``-soft`` Soft-masking the FASTA file.
==========================================================================
Using the **-soft** option, one can optionally "soft-mask" the FASTA file.
For example:
::
cat test.fa
.. code-block:: bash
$ cat test.fa
>chr1
AAAAAAAACCCCCCCCCCCCCGCTACTGGGGGGGGGGGGGGGGGG
cat test.bed
$ cat test.bed
chr1 5 10
maskFastaFromBed -fi test.fa -bed test.bed -fo test.fa.out -soft
$ bedtools maskfasta -fi test.fa -bed test.bed -fo test.fa.out -soft
cat test.fa.out
$ cat test.fa.out
>chr1
AAAAAaaaccCCCCCCCCCCGCTACTGGGGGGGGGGGGGGGGGG
==========================================================================
``-mc`` Specify a masking character.
==========================================================================
Using the **-mc** option, one can optionally choose a masking character to each
base that will be masked by the BED file.
.. code-block:: bash
$ cat test.fa
>chr1
AAAAAAAACCCCCCCCCCCCCGCTACTGGGGGGGGGGGGGGGGGG
$ cat test.bed
chr1 5 10
$ bedtools maskfasta -fi test.fa -bed test.bed -fo test.fa.out -mc X
$ cat test.fa.out
>chr1
AAAAAXXXXXCCCCCCCCCCGCTACTGGGGGGGGGGGGGGGGGG
0% Loading or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment