From 9666fab7fe01e5e95b8ba0108d1950b808842414 Mon Sep 17 00:00:00 2001 From: Yunhai Luo Date: Fri, 23 Aug 2019 18:28:12 -0700 Subject: [PATCH] Fix links in README (#100) --- README.rst | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.rst b/README.rst index 043a503..213affb 100644 --- a/README.rst +++ b/README.rst @@ -210,7 +210,7 @@ Advanced usage with XenaDataset and its subclasses - **Build GDC importing pipelines with** ``GDCOmicset``, ``GDCPhenoset`` **or** ``GDCSurvivalset`` **classes** - ``GDCOmicset``, ``GDCPhenoset`` and ``GDCSurvivalset`` are subclasses of ``XenaDataset`` and are preloaded with settings for importing GDC genomic data, TCGA phenotype data on GDC, TARGET phenotype data on GDC and GDC's survival data respecitively. These settings can be customized by setting corresponding properties described below. For more details, please check the `next section <#gdc-etl-settings>`__ and the `documentation `_. + ``GDCOmicset``, ``GDCPhenoset`` and ``GDCSurvivalset`` are subclasses of ``XenaDataset`` and are preloaded with settings for importing GDC genomic data, TCGA phenotype data on GDC, TARGET phenotype data on GDC and GDC's survival data respecitively. These settings can be customized by setting corresponding properties described below. For more details, please check the `next section <#gdc-etl-settings>`__ and the `documentation `_. The script for ``gdc2xena.py`` command line is a good example for basic usage of these classes. Similar to ``XenaDataset``, a GDC dataset is defined by ``projects``, which is one or a list of valid GDC "project_id". For ``GDCOmicset``, a dataset should also be defined with one of the supported ``xena_dtype`` (find out with the class method ``GDCOmicset.get_supported_dtype()``). The ``xena_dtype`` is critical for a ``GDCOmicset`` object selecting correct default settings. For ``GDCPhenoset`` and ``GDCSurvivalset``, data type are self-explanatory and cannot be changed. Therefore, you can instantiate these classes like this: @@ -251,7 +251,7 @@ Advanced usage with XenaDataset and its subclasses +-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | raws2matrix | Used by the ``transform`` method and responsible for both merging multiple GDC raw data into one Xena matrix and processing new Xena matrix as needed. | ``callable``: takes only 1 list of ``read_raw`` returns as its argument and returns an object (usually a pandas DataFrame) which has a ``to_csv`` method for saving as a file. | Check `GDC genomic transform settings`_ for details | +-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ - | metadata_template | Used by the ``metadata`` method for rendering metadata by Jinja2. | ``jinja2.environment.Template`` or ``str``: a ``jinja2.environment.Template`` used directly by Jinja2; if it's a string, it is a path to the template file which will be silently read and converted to ``jinja2.environment.Template``. | `Resources `_ | + | metadata_template | Used by the ``metadata`` method for rendering metadata by Jinja2. | ``jinja2.environment.Template`` or ``str``: a ``jinja2.environment.Template`` used directly by Jinja2; if it's a string, it is a path to the template file which will be silently read and converted to ``jinja2.environment.Template``. | `Resources `_ | +-------------------+--------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+ | metadata_vars | Used by the ``metadata`` method for rendering metadata by Jinja2. | ``dict``: used directly by Jinja2 which should match variables in ``metadata_template``. | :: | | | | | | @@ -469,4 +469,4 @@ GDC ETL settings Documentation ------------- -Check documentation for GDC module and Xena Dataset module `here `_. +Check documentation for GDC module and Xena Dataset module `here `_.