Skip to content

Consortium to Public

bin.consortium_to_public

Attributes

logger = logging.getLogger(__name__) module-attribute

PWD = os.path.dirname(os.path.abspath(__file__)) module-attribute

parser = argparse.ArgumentParser() module-attribute

args = parser.parse_args() module-attribute

Functions

generate_dashboard_html(genie_version, staging=False)

Generates dashboard html writeout that gets uploaded to the release folder

PARAMETER DESCRIPTION
genie_version

GENIE release

staging

Use staging files. Default is False

DEFAULT: False

Source code in bin/consortium_to_public.py
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
def generate_dashboard_html(genie_version, staging=False):
    """Generates dashboard html writeout that gets uploaded to the
    release folder

    Args:
        genie_version: GENIE release
        staging: Use staging files. Default is False

    """
    markdown_render_cmd = [
        "Rscript",
        os.path.join(PWD, "../R/dashboard_markdown_generator.R"),
        genie_version,
        "--template_path",
        os.path.join(PWD, "../templates/dashboardTemplate.Rmd"),
    ]
    if staging:
        markdown_render_cmd.append("--staging")
    subprocess.check_call(markdown_render_cmd)

generate_data_guide(genie_version, oncotree_version=None, database_mapping=None)

Generates the GENIE data guide

Source code in bin/consortium_to_public.py
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
def generate_data_guide(genie_version, oncotree_version=None, database_mapping=None):
    """Generates the GENIE data guide"""

    template_path = os.path.join(PWD, "../templates/data_guide_template.Rnw")
    with open(template_path, "r") as template_file:
        template_str = template_file.read()

    replacements = {
        "{{release}}": genie_version,
        "{{database_synid}}": database_mapping,
        "{{oncotree}}": oncotree_version.replace("_", "\\_"),
        "{{genie_banner}}": os.path.join(PWD, "../genie_banner.png"),
    }

    for search in replacements:
        replacement = replacements[search]
        # If no replacement value is passed in, don't replace
        if replacement is not None:
            template_str = template_str.replace(search, replacement)

    with open(os.path.join(PWD, "data_guide.Rnw"), "w") as data_guide_file:
        data_guide_file.write(template_str)

    subprocess.check_call(
        ["R", "CMD", "Sweave", "--pdf", os.path.join(PWD, "data_guide.Rnw")]
    )
    return "data_guide.pdf"

main(args)

Source code in bin/consortium_to_public.py
 72
 73
 74
 75
 76
 77
 78
 79
 80
 81
 82
 83
 84
 85
 86
 87
 88
 89
 90
 91
 92
 93
 94
 95
 96
 97
 98
 99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
def main(args):
    # HACK: Delete all existing files first
    process_functions.rmFiles(database_to_staging.GENIE_RELEASE_DIR)

    cbioValidatorPath = os.path.join(
        args.cbioportalPath, "core/src/main/scripts/importer/validateData.py"
    )
    assert os.path.exists(cbioValidatorPath), "Please specify correct cbioportalPath"
    assert not (
        args.test and args.staging
    ), "You can only specify --test or --staging, not both"
    try:
        processingDate = datetime.datetime.strptime(args.processingDate, "%b-%Y")
    except ValueError:
        raise ValueError(
            "Process date must be in the format " "abbreviated_month-YEAR ie. Oct-2017"
        )

    syn = process_functions.synapse_login(debug=args.debug)

    # Get all the possible public releases
    # Get configuration
    if args.test:
        databaseSynIdMappingId = "syn11600968"
        args.genieVersion = "TESTpublic"
    elif args.staging:
        databaseSynIdMappingId = "syn12094210"
    else:
        databaseSynIdMappingId = "syn10967259"
    databaseSynIdMapping = syn.tableQuery("select * from %s" % databaseSynIdMappingId)
    databaseSynIdMappingDf = databaseSynIdMapping.asDataFrame()
    public_synid = databaseSynIdMappingDf["Id"][
        databaseSynIdMappingDf["Database"] == "public"
    ].values[0]
    # Use release folder fileview
    releaseSynId = databaseSynIdMappingDf["Id"][
        databaseSynIdMappingDf["Database"] == "releaseFolder"
    ].values[0]
    processTrackerSynId = databaseSynIdMappingDf["Id"][
        databaseSynIdMappingDf["Database"] == "processTracker"
    ].values[0]
    # TEST run of the infrastructure will always
    # Map to a specific folder
    if args.test:
        officialPublic = {"TESTpublic": "syn12299959"}
    else:
        officialPublic = extract.get_public_to_consortium_synid_mapping(
            syn, releaseSynId
        )
    if args.genieVersion not in officialPublic.keys():
        allowed_public_release_names = ", ".join(officialPublic.keys())
        raise ValueError(
            f"genieVersion must be one of these: {allowed_public_release_names}."
        )

    args.releaseId = officialPublic[args.genieVersion]
    if not args.test and not args.staging:
        load.update_process_trackingdf(
            syn=syn,
            process_trackerdb_synid=processTrackerSynId,
            center="SAGE",
            process_type="public",
            start=True,
        )

    caseListEntities, genePanelEntities = consortium_to_public.consortiumToPublic(
        syn,
        processingDate,
        args.genieVersion,
        args.releaseId,
        databaseSynIdMappingDf,
        publicReleaseCutOff=args.publicReleaseCutOff,
    )

    database_to_staging.revise_metadata_files(syn, public_synid, args.genieVersion)

    logger.info("CBIO VALIDATION")
    # Must be exit 0 because the validator sometimes fails,
    # but we still want to capture the output
    command = [
        cbioValidatorPath,
        "-s",
        database_to_staging.GENIE_RELEASE_DIR,
        "-n",
        "; exit 0",
    ]
    cbio_output = subprocess.check_output(" ".join(command), shell=True)
    cbio_decoded_output = cbio_output.decode("utf-8")
    logger.info(cbio_decoded_output)
    if not args.test and not args.staging:
        log_folder_synid = databaseSynIdMappingDf["Id"][
            databaseSynIdMappingDf["Database"] == "logs"
        ].values[0]
        # Use tempfiles
        cbio_log_file = "cbioValidatorLogsPublic_{}.txt".format(args.genieVersion)
        with open(cbio_log_file, "w") as cbioLog:
            cbioLog.write(cbio_decoded_output)
        syn.store(synapseclient.File(cbio_log_file, parentId=log_folder_synid))
        os.remove(cbio_log_file)
    # logger.info("REMOVING OLD FILES")
    # process_functions.rmFiles(database_to_staging.CASE_LIST_PATH)
    # seg_meta_file = "{}/genie_public_meta_cna_hg19_seg.txt".format(
    #     database_to_staging.GENIE_RELEASE_DIR
    # )
    # if os.path.exists(seg_meta_file):
    #     os.unlink(seg_meta_file)

    logger.info("CREATING LINK VERSION")
    folders = database_to_staging.create_link_version(
        syn,
        args.genieVersion,
        caseListEntities,
        genePanelEntities,
        databaseSynIdMappingDf,
        release_type="public",
    )
    # Don't update process tracker is testing or staging
    if not args.test and not args.staging:
        load.update_process_trackingdf(
            syn=syn,
            process_trackerdb_synid=processTrackerSynId,
            center="SAGE",
            process_type="public",
            start=False,
        )

    if not args.test:
        logger.info("DASHBOARD UPDATE")
        dashboard_table_updater.run_dashboard(
            syn, databaseSynIdMappingDf, args.genieVersion, staging=args.staging
        )
        generate_dashboard_html(args.genieVersion, staging=args.staging)
        logger.info("DASHBOARD UPDATE COMPLETE")
        logger.info("AUTO GENERATE DATA GUIDE")

    # TODO: remove data guide code
    # onco_link = databaseSynIdMappingDf["Id"][
    #    databaseSynIdMappingDf["Database"] == "oncotreeLink"
    # ].values[0]
    # onco_link_ent = syn.get(onco_link)
    # oncotree_link = onco_link_ent.externalURL
    # oncotree_version = oncotree_link.split("=")[1]

    # data_guide_pdf = generate_data_guide(
    #    args.genieVersion,
    #    oncotree_version=oncotree_version,
    #    database_mapping=databaseSynIdMappingId,
    # )
    # data_guide_ent = synapseclient.File(
    #    data_guide_pdf, parent=folders["release_folder"]
    # )
    # syn.store(data_guide_ent)
    logger.info("COMPLETED CONSORTIUM TO PUBLIC")