{"_id":"58f5d56702c293230028f0a1","parentDoc":null,"project":"55faf11ba62ba1170021a9a7","category":{"_id":"58f5d52d7891630f00fe4e77","project":"55faf11ba62ba1170021a9a7","version":"55faf11ba62ba1170021a9aa","__v":0,"sync":{"url":"","isSync":false},"reference":false,"createdAt":"2017-04-18T08:58:21.978Z","from_sync":false,"order":34,"slug":"data-cruncher","title":"DATA CRUNCHER"},"__v":0,"user":"5767bc73bb15f40e00a28777","version":{"_id":"55faf11ba62ba1170021a9aa","project":"55faf11ba62ba1170021a9a7","__v":40,"createdAt":"2015-09-17T16:58:03.490Z","releaseDate":"2015-09-17T16:58:03.490Z","categories":["55faf11ca62ba1170021a9ab","55faf8f4d0e22017005b8272","55faf91aa62ba1170021a9b5","55faf929a8a7770d00c2c0bd","55faf932a8a7770d00c2c0bf","55faf94b17b9d00d00969f47","55faf958d0e22017005b8274","55faf95fa8a7770d00c2c0c0","55faf96917b9d00d00969f48","55faf970a8a7770d00c2c0c1","55faf98c825d5f19001fa3a6","55faf99aa62ba1170021a9b8","55faf99fa62ba1170021a9b9","55faf9aa17b9d00d00969f49","55faf9b6a8a7770d00c2c0c3","55faf9bda62ba1170021a9ba","5604570090ee490d00440551","5637e8b2fbe1c50d008cb078","5649bb624fa1460d00780add","5671974d1b6b730d008b4823","5671979d60c8e70d006c9760","568e8eef70ca1f0d0035808e","56d0a2081ecc471500f1795e","56d4a0adde40c70b00823ea3","56d96b03dd90610b00270849","56fbb83d8f21c817002af880","573c811bee2b3b2200422be1","576bc92afb62dd20001cda85","5771811e27a5c20e00030dcd","5785191af3a10c0e009b75b0","57bdf84d5d48411900cd8dc0","57ff5c5dc135231700aed806","5804caf792398f0f00e77521","58458b4fba4f1c0f009692bb","586d3c287c6b5b2300c05055","58ef66d88646742f009a0216","58f5d52d7891630f00fe4e77","59a555bccdbd85001bfb1442","5a2a81f688574d001e9934f5","5b080c8d7833b20003ddbb6f"],"is_deprecated":false,"is_hidden":false,"is_beta":true,"is_stable":true,"codename":"","version_clean":"1.0.0","version":"1.0"},"updates":[],"next":{"pages":[],"description":""},"createdAt":"2017-04-18T08:59:19.555Z","link_external":false,"link_url":"","githubsync":"","sync_unique":"","hidden":false,"api":{"settings":"","results":{"codes":[]},"auth":"required","params":[],"url":""},"isReference":false,"order":2,"body":"The analysis editor is the central point of Data Cruncher analyses as it is where the actual code editing and execution takes place. This document provides a brief description of the editor environment and its commonly used commands.\n\n## The editor interface\n\nOnce you have set up and started an analysis, create a notebook where you will enter your code. The editor screen showing a notebook looks like this:\n[block:image]\n{\n  \"images\": [\n    {\n      \"image\": [\n        \"https://files.readme.io/4ebcc7a-Data_Cruncher_Terminal.png\",\n        \"Data Cruncher Terminal.png\",\n        1355,\n        732,\n        \"#e7e7e7\"\n      ]\n    }\n  ]\n}\n[/block]\nThe main elements of the editor are:\n1. **Notebook** - The document that contains the code and outputs of an interactive analysis, as well as additional markdown or raw text that accompanies the code, but is not meant for execution.\n\n2. **Cell** - A single section of a notebook where you can enter code, markdown or raw text.\n\n3. **Toolbar** - Allows you to quickly perform the most common actions within a notebook, by clicking on an icon:\n * <img src=\"https://files.readme.io/519377b-save.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Saves the current content of the notebook.\n * <img src=\"https://files.readme.io/2af6e1f-add.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Adds a new cell below the selected one.\n * <img src=\"https://files.readme.io/f84c5cc-cut.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Cuts the currently selected cell(s).\n * <img src=\"https://files.readme.io/64e7f6b-copy.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Copies the currently selected cell(s).\n * <img src=\"https://files.readme.io/9bcbfde-paste.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Pastes the copied cell(s).\n * <img src=\"https://files.readme.io/463bd79-run.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Executes the code in the current cell and moves to the next cell.\n * <img src=\"https://files.readme.io/6ddbef9-stop.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Stops the execution.\n * <img src=\"https://files.readme.io/a8c41ca-reload.png\" width=\"auto\" align=\"inline\" style=\"margin:1px\"/> Restarts the kernel.\n * <img src=\"https://files.readme.io/6957353-type.png\" width=\"auto\" align=\"inline\" style=\"margin:1px; border: 1px solid #000;\"/> Defines the cell type. Can be **code**, **markdown** or **raw**.\n\n4. Left-hand panel with the following tabs:\n * **Files** - Displays files that are created or added (uploaded or downloaded) within the analysis itself, including the Jupyter notebooks (**.ipynb** files). Files that are grayed out will not be saved automatically after the analysis is stopped. However, you can always choose to save a file manually, by right-clicking it and selecting **Save To Project**.\n * **Running** - Displays the kernel sessions that are currently running. One kernel session corresponds to one open notebook.\n * **Commands** - Shows a list of commands that can be used within the editor, along with their keyboard shortcuts. To execute a command, click it in the list.\n * **Project Files** - Lists all files from the project (available under the **Files** tab in the project) in which you are executing your analysis. To use a project file in your analysis, you need to reference it in the code using its full path. Clicking a file in the list will copy the path to the clipboard, which you can then paste in your code.\n\n5. **Terminal console** - This is a JupyterLab Terminal extension equivalent to a Linux shell. \n\n6. Analysis control buttons:\n\n * **Stop Analysis** - Allows you to stop the analysis directly from the editor.\n * **Go To Analysis** - Takes you to the analysis details page.\n\n## Commonly used text commands\n\nBesides execution of Python, R or Julia code, you can also run the following types of commands directly in your notebook:\n\n* **Magic commands** - a set of predefined functions that you can call with a command line style syntax. Magic commands can begin with a single `%` symbol, in which case they take the rest of the line as an argument. If you prefix a magic command with a double `%` symbol (`%%`), it will take the rest of the cell as its argument. Learn more about [magic commands](http://ipython.readthedocs.io/en/stable/interactive/magics.html) or type `%magic` in a blank cell and execute it.\n* **Linux shell commands** - You can also run any system shell command by prefixing it with an exclamation mark (`!`), for example `!ls`. You can even combine shell commands with the rest of the code in your notebook, for example:\n[block:code]\n{\n  \"codes\": [\n    {\n      \"code\": \"myfiles = !ls\",\n      \"language\": \"python\"\n    }\n  ]\n}\n[/block]\n This line of code will assign the list of files returned by the `ls` command to the `myfiles` variable.\n\nFind out more about functionalities related to [text commands](http://ipython.readthedocs.io/en/stable/interactive/tutorial.html).","excerpt":"","slug":"editor-quick-reference","type":"basic","title":"Editor quick reference"}

GET STARTED

TUTORIALS

ACCESS THE CGC

MANAGE AN ANALYSIS ENVIRONMENT

COLLABORATE SECURELY

DATASETS HUB

PUBLIC PROJECTS

BRING YOUR PRIVATE DATA

SET METADATA ASSOCIATED WITH A PRIVATE FILE

SEARCH FILES

ADD FILES TO A PROJECT

ORGANIZE FILES

ARCHIVE FILES

FIND APPS

BRING YOUR TOOLS

DESCRIBE YOUR TOOL

TOOL WRAPPING TIPS AND TRICKS

EDIT AN APP

ARCHIVE APPS

RUN AN ANALYSIS

TASK EXECUTION

REVIEW A TASK

VIEW ANALYSIS RESULTS

INTERACTIVE ANALYSIS

DOWNLOAD RESULTS

DEVELOPER TOOLS

CONNECT CLOUD STORAGE

API Hub

API Reference

FOLDERS API (Advance Access)

BULK API ACTIONS

WATCH AND LEARN

DATA CRUNCHER

SBFS (Beta)

SBFS Command Reference

GLOSSARY

Editor quick reference

The analysis editor is the central point of Data Cruncher analyses as it is where the actual code editing and execution takes place. This document provides a brief description of the editor environment and its commonly used commands. ## The editor interface Once you have set up and started an analysis, create a notebook where you will enter your code. The editor screen showing a notebook looks like this: [block:image] { "images": [ { "image": [ "https://files.readme.io/4ebcc7a-Data_Cruncher_Terminal.png", "Data Cruncher Terminal.png", 1355, 732, "#e7e7e7" ] } ] } [/block] The main elements of the editor are: 1. **Notebook** - The document that contains the code and outputs of an interactive analysis, as well as additional markdown or raw text that accompanies the code, but is not meant for execution. 2. **Cell** - A single section of a notebook where you can enter code, markdown or raw text. 3. **Toolbar** - Allows you to quickly perform the most common actions within a notebook, by clicking on an icon: * <img src="https://files.readme.io/519377b-save.png" width="auto" align="inline" style="margin:1px"/> Saves the current content of the notebook. * <img src="https://files.readme.io/2af6e1f-add.png" width="auto" align="inline" style="margin:1px"/> Adds a new cell below the selected one. * <img src="https://files.readme.io/f84c5cc-cut.png" width="auto" align="inline" style="margin:1px"/> Cuts the currently selected cell(s). * <img src="https://files.readme.io/64e7f6b-copy.png" width="auto" align="inline" style="margin:1px"/> Copies the currently selected cell(s). * <img src="https://files.readme.io/9bcbfde-paste.png" width="auto" align="inline" style="margin:1px"/> Pastes the copied cell(s). * <img src="https://files.readme.io/463bd79-run.png" width="auto" align="inline" style="margin:1px"/> Executes the code in the current cell and moves to the next cell. * <img src="https://files.readme.io/6ddbef9-stop.png" width="auto" align="inline" style="margin:1px"/> Stops the execution. * <img src="https://files.readme.io/a8c41ca-reload.png" width="auto" align="inline" style="margin:1px"/> Restarts the kernel. * <img src="https://files.readme.io/6957353-type.png" width="auto" align="inline" style="margin:1px; border: 1px solid #000;"/> Defines the cell type. Can be **code**, **markdown** or **raw**. 4. Left-hand panel with the following tabs: * **Files** - Displays files that are created or added (uploaded or downloaded) within the analysis itself, including the Jupyter notebooks (**.ipynb** files). Files that are grayed out will not be saved automatically after the analysis is stopped. However, you can always choose to save a file manually, by right-clicking it and selecting **Save To Project**. * **Running** - Displays the kernel sessions that are currently running. One kernel session corresponds to one open notebook. * **Commands** - Shows a list of commands that can be used within the editor, along with their keyboard shortcuts. To execute a command, click it in the list. * **Project Files** - Lists all files from the project (available under the **Files** tab in the project) in which you are executing your analysis. To use a project file in your analysis, you need to reference it in the code using its full path. Clicking a file in the list will copy the path to the clipboard, which you can then paste in your code. 5. **Terminal console** - This is a JupyterLab Terminal extension equivalent to a Linux shell. 6. Analysis control buttons: * **Stop Analysis** - Allows you to stop the analysis directly from the editor. * **Go To Analysis** - Takes you to the analysis details page. ## Commonly used text commands Besides execution of Python, R or Julia code, you can also run the following types of commands directly in your notebook: * **Magic commands** - a set of predefined functions that you can call with a command line style syntax. Magic commands can begin with a single `%` symbol, in which case they take the rest of the line as an argument. If you prefix a magic command with a double `%` symbol (`%%`), it will take the rest of the cell as its argument. Learn more about [magic commands](http://ipython.readthedocs.io/en/stable/interactive/magics.html) or type `%magic` in a blank cell and execute it. * **Linux shell commands** - You can also run any system shell command by prefixing it with an exclamation mark (`!`), for example `!ls`. You can even combine shell commands with the rest of the code in your notebook, for example: [block:code] { "codes": [ { "code": "myfiles = !ls", "language": "python" } ] } [/block] This line of code will assign the list of files returned by the `ls` command to the `myfiles` variable. Find out more about functionalities related to [text commands](http://ipython.readthedocs.io/en/stable/interactive/tutorial.html).