diff --git a/docs/concepts/GAMBLR_family.html b/docs/concepts/GAMBLR_family.html index f5af8bb..a795de8 100644 --- a/docs/concepts/GAMBLR_family.html +++ b/docs/concepts/GAMBLR_family.html @@ -102,6 +102,10 @@
  • Installation +
    • +
  • + + Frequently Asked Qestions
    • diff --git a/docs/concepts/glossary.html b/docs/concepts/glossary.html index c8e874c..6e0a27f 100644 --- a/docs/concepts/glossary.html +++ b/docs/concepts/glossary.html @@ -99,6 +99,10 @@
  • Installation +
    • +
  • + + Frequently Asked Qestions
    • diff --git a/docs/faq.html b/docs/faq.html new file mode 100644 index 0000000..cfb3525 --- /dev/null +++ b/docs/faq.html @@ -0,0 +1,692 @@ + + + + + + + + + +GAMBLR.viz - Frequently Asked Qestions + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +
    +
    + + +
    + +
    + + +
    + + + +
    + +
    +
    +

    Frequently Asked Qestions

    +
    + + + +
    + + + + +
    + + +
    + +

    This section will cover most of the questions you may have about GAMBLR.viz. If there is something that is not covered, please feel free to reach out to us via GitHub by reporting an issue and we will be happy to add it to this page.

    +
    +

    +
    + +
    +
    +
    +
    +

    Where can I get example data that works with this package?

    +

    The example data of all types is available with one of GAMBLR.viz dependencies (GAMBLR.data). Every function demonstrates how to get this data in it’s example, or is already setup to automatically retreive it for you with minimal information (e.g. sample_id).

    +
    +
    +

    Can I use my own colors and not the ones the package offers?

    +

    Absolutely! Most functions will accept argument custom_colours where list of color mappings can be used to specify your own pallette.

    +
    +
    +

    Can I use my own data we generated in our lab?

    +

    Absolutely! Most functions will accept metadata and data frame with mutations as input, so you can provide any outside data as long as the formatting is consistent with the example data.

    +
    +
    + + + + Back to top
    + +
    + + + + + \ No newline at end of file diff --git a/docs/faq.qmd b/docs/faq.qmd new file mode 100644 index 0000000..ecb5725 --- /dev/null +++ b/docs/faq.qmd @@ -0,0 +1,37 @@ +--- +title: "Frequently Asked Qestions" +echo: false +--- + +This section will cover most of the questions you may have about GAMBLR.viz. If +there is something that is not covered, please feel free to reach out to us via +GitHub by reporting an [issue](https://github.com/morinlab/GAMBLR.viz/issues/new) +and we will be happy to add it to this page. + +### + + +
    + +::: {#General .collapse .multi-collapse} + +## Where can I get example data that works with this package? + +The example data of all types is available with one of GAMBLR.viz dependencies +([GAMBLR.data](https://github.com/morinlab/GAMBLR.data)). Every function +demonstrates how to get this data in it's example, or is already setup to +automatically retreive it for you with minimal information (e.g. sample_id). + + +## Can I use my own colors and not the ones the package offers? + +Absolutely! Most functions will accept argument `custom_colours` where list +of color mappings can be used to specify your own pallette. + +## Can I use my own data we generated in our lab? + +Absolutely! Most functions will accept metadata and data frame with mutations +as input, so you can provide any outside data as long as the formatting is +consistent with the example data. + +::: diff --git a/docs/index.html b/docs/index.html index 70a4523..d0f5351 100644 --- a/docs/index.html +++ b/docs/index.html @@ -133,6 +133,10 @@
  • Installation +
    • +
  • + + Frequently Asked Qestions
    • diff --git a/docs/install.html b/docs/install.html index f293298..6fc60ba 100644 --- a/docs/install.html +++ b/docs/install.html @@ -129,6 +129,10 @@
  • Installation +
    • +
  • + + Frequently Asked Qestions
    • @@ -214,8 +218,11 @@
  • - faq.qmd -
    • +
    + + Frequently Asked Qestions +
    + diff --git a/docs/search.json b/docs/search.json index ac5d6c0..c7447af 100644 --- a/docs/search.json +++ b/docs/search.json @@ -13,6 +13,34 @@ "section": "", "text": "Installation\nWe recommend installing the package directly from GitHub (requires devtools dependency).\nif (!require(\"devtools\")) install.packages(\"devtools\")\n\ndevtools::install_github(\n \"morinlab/GAMBLR.viz\",\n repos = BiocManager::repositories()\n)\nYou can confirm successful installation by running one of the most popular functions:\nlibrary(GAMBLR.data)\n\nmaf_metadata <- get_gambl_metadata(seq_type_filter = \"genome\") %>%\n dplyr::filter(pathology %in% c(\"FL\", \"DLBCL\"))\n\nmaf_data <- get_ssm_by_samples(\n these_samples_metadata = maf_metadata\n)\n\n#define some genes of interest\nfl_genes = c(\"RRAGC\", \"CREBBP\", \"VMA21\", \"ATP6V1B2\")\ndlbcl_genes = c(\"EZH2\", \"KMT2D\", \"MEF2B\", \"CD79B\", \"MYD88\", \"TP53\")\ngenes = c(fl_genes, dlbcl_genes)\n\nprettyOncoplot(\n maf_df = maf_data,\n genes = genes,\n these_samples_metadata = maf_metadata\n)\nThere is a lot of functionality to hand-craft this plot exactly in the way you want. Interested? Read more in the tutorials section.\n\n\n\n\n Back to top" }, + { + "objectID": "index.html", + "href": "index.html", + "title": "GAMBLR.viz", + "section": "", + "text": "Why use GAMBLR.viz?\n \n \n \n How to install?\n \n \n \n How to use?\n \n \n \n Release notes\n \n \n \n GitHub" + }, + { + "objectID": "index.html#install", + "href": "index.html#install", + "title": "GAMBLR.viz", + "section": "Install", + "text": "Install\nWe recommend installing the package directly from GitHub (requires devtools dependency).\ndevtools::install_github(\n \"morinlab/GAMBLR.viz\",\n repos = BiocManager::repositories()\n)\n\n\n\nShow quickstart" + }, + { + "objectID": "index.html#quickstart", + "href": "index.html#quickstart", + "title": "GAMBLR.viz", + "section": "Quickstart", + "text": "Quickstart\nThe quick and easy way to get started is to make sure the devtools dependency is installed, then install the GAMBLR.viz:\n# Verify devtools is installed\nif (!require(\"devtools\")) install.packages(\"devtools\")\n\n# Install GAMBLR.viz\ndevtools::install_github(\n \"morinlab/GAMBLR.viz\",\n repos = BiocManager::repositories()\n)" + }, + { + "objectID": "index.html#installation-for-developers", + "href": "index.html#installation-for-developers", + "title": "GAMBLR.viz", + "section": "Installation for developers", + "text": "Installation for developers\nThe easiest way to obtain and contribute to GAMBLR.viz is to do this via cloning the repository\ncd\ngit clone git@github.com:morinlab/GAMBLR.viz.git\nIn your R editor of choice (which is hopefully VS Code now), set your working directory to the place you just cloned the repo.\nsetwd(\"~/GAMBLR.viz\")\nInstall the package in R by running the following command (requires the devtools package):\ndevtools::install()\nAfter applying your modifications to the code, use the following command to quickly test your changes without directly installing the packaage (requires the devtools dependency):\ndevtools::load_all()\nGAMBLR.viz is a free open-source package, but the Master branch is protected. We welcome contributions (pull request, bug report, feature request, PR review) from all levels of users. All commits must be submitted via pull request on a branch. Please refer to the GitHub documentation for details on how to do pull request." + }, { "objectID": "why.html", "href": "why.html", @@ -56,32 +84,32 @@ "text": "Getting started\nIf you’re interested in trying GAMBLR.viz we recommend the getting started tutorial." }, { - "objectID": "index.html", - "href": "index.html", - "title": "GAMBLR.viz", + "objectID": "faq.html", + "href": "faq.html", + "title": "Frequently Asked Qestions", "section": "", - "text": "Why use GAMBLR.viz?\n \n \n \n How to install?\n \n \n \n How to use?\n \n \n \n Release notes\n \n \n \n GitHub" + "text": "This section will cover most of the questions you may have about GAMBLR.viz. If there is something that is not covered, please feel free to reach out to us via GitHub by reporting an issue and we will be happy to add it to this page." }, { - "objectID": "index.html#install", - "href": "index.html#install", - "title": "GAMBLR.viz", - "section": "Install", - "text": "Install\nWe recommend installing the package directly from GitHub (requires devtools dependency).\ndevtools::install_github(\n \"morinlab/GAMBLR.viz\",\n repos = BiocManager::repositories()\n)\n\n\n\nShow quickstart" + "objectID": "faq.html#where-can-i-get-example-data-that-works-with-this-package", + "href": "faq.html#where-can-i-get-example-data-that-works-with-this-package", + "title": "Frequently Asked Qestions", + "section": "Where can I get example data that works with this package?", + "text": "Where can I get example data that works with this package?\nThe example data of all types is available with one of GAMBLR.viz dependencies (GAMBLR.data). Every function demonstrates how to get this data in it’s example, or is already setup to automatically retreive it for you with minimal information (e.g. sample_id)." }, { - "objectID": "index.html#quickstart", - "href": "index.html#quickstart", - "title": "GAMBLR.viz", - "section": "Quickstart", - "text": "Quickstart\nThe quick and easy way to get started is to make sure the devtools dependency is installed, then install the GAMBLR.viz:\n# Verify devtools is installed\nif (!require(\"devtools\")) install.packages(\"devtools\")\n\n# Install GAMBLR.viz\ndevtools::install_github(\n \"morinlab/GAMBLR.viz\",\n repos = BiocManager::repositories()\n)" + "objectID": "faq.html#can-i-use-my-own-colors-and-not-the-ones-the-package-offers", + "href": "faq.html#can-i-use-my-own-colors-and-not-the-ones-the-package-offers", + "title": "Frequently Asked Qestions", + "section": "Can I use my own colors and not the ones the package offers?", + "text": "Can I use my own colors and not the ones the package offers?\nAbsolutely! Most functions will accept argument custom_colours where list of color mappings can be used to specify your own pallette." }, { - "objectID": "index.html#installation-for-developers", - "href": "index.html#installation-for-developers", - "title": "GAMBLR.viz", - "section": "Installation for developers", - "text": "Installation for developers\nThe easiest way to obtain and contribute to GAMBLR.viz is to do this via cloning the repository\ncd\ngit clone git@github.com:morinlab/GAMBLR.viz.git\nIn your R editor of choice (which is hopefully VS Code now), set your working directory to the place you just cloned the repo.\nsetwd(\"~/GAMBLR.viz\")\nInstall the package in R by running the following command (requires the devtools package):\ndevtools::install()\nAfter applying your modifications to the code, use the following command to quickly test your changes without directly installing the packaage (requires the devtools dependency):\ndevtools::load_all()\nGAMBLR.viz is a free open-source package, but the Master branch is protected. We welcome contributions (pull request, bug report, feature request, PR review) from all levels of users. All commits must be submitted via pull request on a branch. Please refer to the GitHub documentation for details on how to do pull request." + "objectID": "faq.html#can-i-use-my-own-data-we-generated-in-our-lab", + "href": "faq.html#can-i-use-my-own-data-we-generated-in-our-lab", + "title": "Frequently Asked Qestions", + "section": "Can I use my own data we generated in our lab?", + "text": "Can I use my own data we generated in our lab?\nAbsolutely! Most functions will accept metadata and data frame with mutations as input, so you can provide any outside data as long as the formatting is consistent with the example data." }, { "objectID": "concepts/glossary.html", diff --git a/docs/why.html b/docs/why.html index dd189ce..321dfd4 100644 --- a/docs/why.html +++ b/docs/why.html @@ -99,6 +99,10 @@
  • Installation +
    • +
  • + + Frequently Asked Qestions