From d7e5c92dccbe945f6980f5b626ef4c5682ce7775 Mon Sep 17 00:00:00 2001 From: Laura Luebbert <56094636+lauraluebbert@users.noreply.github.com> Date: Mon, 22 Jan 2024 13:55:50 -0800 Subject: [PATCH] Create cosmic.md --- docs/src/es/cosmic.md | 45 +++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 45 insertions(+) create mode 100644 docs/src/es/cosmic.md diff --git a/docs/src/es/cosmic.md b/docs/src/es/cosmic.md new file mode 100644 index 00000000..2ca86448 --- /dev/null +++ b/docs/src/es/cosmic.md @@ -0,0 +1,45 @@ +> Parámetros de Python són iguales a los parámetros largos (`--parámetro`) de Terminal, si no especificado de otra manera. Las banderas son parámetros de verdadero o falso (True/False) en Python. El manuál para cualquier modulo de gget se puede llamar desde la Terminal con la bandera `-h` `--help`. +## gget cosmic 🪐 +Busque genes, mutaciones, etc. asociados con cánceres utilizando la base de datos [COSMIC](https://cancer.sanger.ac.uk/cosmic) (Catálogo de mutaciones somáticas en cáncer). +Produce: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python). + +**Parámetro posicional** +`searchterm` +Término de búsqueda. Puede ser una mutación, un gen (o ID de Ensembl), una muestra, etc., tal como se define con el argumento `entity`. Ejemplo: 'EGFR' + +**Parámetros optionales** +`-e` `--entity` +'mutations', 'genes', 'cancer', 'tumour site', 'studies', 'pubmed', o 'samples'. Por defecto: 'mutations'. +Define el tipo de término de búsqueda (`searchterm`). + +`-l` `--limit` +Limita el número de resultados producidos. Por defecto: 100. + +`-o` `--out` +Ruta al archivo en el que se guardarán los resultados, p. ej. ruta/al/directorio/resultados.csv (o .json). Por defecto: salida estándar (STDOUT). +Para Python, usa `save=True` para guardar los resultados en el directorio de trabajo actual. + +**Banderas** +`-csv` `--csv` +Solo para Terminal. Produce los resultados en formato CSV. +Para Python, usa json=True para producir los resultados en formato JSON. + +`-q` `--quiet` +Solo para Terminal. Impide la información de progreso de ser exhibida durante la ejecución del programa. +Para Python, usa `verbose=False` para imipidir la informacion de progreso de ser exhibida durante la ejecución del programa. + + +### Por ejemplo +```bash +gget cosmic -e genes EGFR +``` +```python +# Python +gget.cosmic("EGFR", entity="genes") +``` +→ Produce los resultados COSMIC para el gen 'EGFR': + +| Gene | Alternate IDs | Tested samples | Simple Mutations | Fusions | Coding Mutations | ... | +| -------------- |-------------------------| ------------------------| -------------- | ----------|-----|---| +| EGFR| EGFR,ENST00000275493.6,... | 210280 | 31900 | 0 | 31900 | ... | +| . . . | . . . | . . . | . . . | . . . | . . . | . . . | ... |