Skip to content

Commit

Permalink
Merge pull request #105 from victorg775/main
Browse files Browse the repository at this point in the history
Laura is the best
  • Loading branch information
lauraluebbert authored Oct 7, 2023
2 parents b4207eb + 37d28cd commit 6a42a35
Show file tree
Hide file tree
Showing 7 changed files with 104 additions and 105 deletions.
36 changes: 18 additions & 18 deletions docs/src/es/alphafold.md
Original file line number Diff line number Diff line change
@@ -1,21 +1,21 @@
> Parámetros de Python són iguales a los parámetros largos (`--parámetro`) de Terminal, si no especificado de otra manera. 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 alphafold 🪢
Predice la estructura en 3D de cualquier proteína basada sobre su secuencia de aminoácidos usando una versión simpleficada del algoritmo [AlphaFold2](https://github.com/deepmind/alphafold) de [DeepMind](https://www.deepmind.com/), originalmente producido y hecho público para [AlphaFold Colab](https://colab.research.google.com/github/deepmind/alphafold/blob/main/notebooks/AlphaFold.ipynb).
Regresa: La estructura pedicada (en formato PDB) y el errór de alineación (en formato json).
Predice la estructura en 3D de cualquier proteína derivada de su secuencia de aminoácidos usando una versión simplificada del algoritmo [AlphaFold2](https://github.com/deepmind/alphafold) de [DeepMind](https://www.deepmind.com/), originalmente producido y publicado para [AlphaFold Colab](https://colab.research.google.com/github/deepmind/alphafold/blob/main/notebooks/AlphaFold.ipynb).
Resultado: Predicción de la estructura (en formato PDB) y el errór de alineación (en formato json).

Antes de usar `gget alphafold` por primera vez, corre `gget setup alphafold` / `gget.setup("alphafold")` (ver también [`gget setup`](setup.md)).

**Parámetro posicional**
`sequence`
Secuencia de aminoácidos (str), o una lista de secuencias (*gget alphafold automaticamente usa el algoritmo de multímero si múltiple secuencias son ingresadas*), o una ruta a un archivo tipo FASTA.
Secuencia de aminoácidos (str), o una lista de secuencias (*gget alphafold automaticamente usa el algoritmo del multímero si múltiples secuencias son ingresadas*), o una ruta a un archivo formato FASTA.

**Parámetros optionales**
`-mr` `--multimer_recycles`
El algoritmo de multímero continuara a recyclar hasta que los prediciones paren de cambiar, hasta el limite indicado aquí. Por defecto: 3
Para obtener más exactitude ajusta a 20 (al costo de corridas más largas).
El algoritmo de multímero se reciclara hasta que las predicciones dejen de cambiar, el limite de ciclos esta indicado aqui. Por defecto: 3
Para obtener más exactitud, ajusta este limite a 20 (al costo de ejecuciones mas tardadas).

`-o` `--out`
Ruta a una carpeta para guardar los resultados de la predicción (str). Por defecto: "./[fecha_tiempo]_gget_alphafold_prediction".
Ruta a la carpeta para guardar los resultados de la predicción (str). Por defecto: "./[fecha_tiempo]_gget_alphafold_prediction".

**Banderas**
`-mfm` `--multimer_for_monomer`
Expand All @@ -25,41 +25,41 @@ Usa el algoritmo de multímero para un monómero.
Relaja el mejor modelo con el algoritmo AMBER.

`-q` `--quiet`
Solo para la Terminal. Impide la informacion de progreso de ser exhibida durante la corrida.
Para Python, usa `verbose=False` para imipidir la informacion de progreso de ser exhibida durante la corrida.
Uso limitado para Terminal. Impide la información de progreso de ser exhibida durante la ejecución del programa.
Para Python, usa `verbose=False`.

`plot`
Solo para Python. `plot=True` provee una visualización interactiva de la predicción con el errór de alineación en 3D con [py3Dmol](https://pypi.org/project/py3Dmol/) y [matplotlib](https://matplotlib.org/) (por defecto: True).
Solo para Python. `plot=True` provée una visualización interactiva de la predicción con el errór de alineación en 3D con [py3Dmol](https://pypi.org/project/py3Dmol/) y [matplotlib](https://matplotlib.org/) (por defecto: True).

`show_sidechains`
Solo para Python. `show_sidechains=True` incluye las cadenas laterales de proteínas en la visualización (por defecto: True).
Solo para Python. `show_sidechains=True` incluye las cadenas laterales de proteínas en el esquema (por defecto: True).


### Por ejemplo
### Ejemplo
```bash
# Predice la estructura de una proteína basada sobre su secuencia de aminoácidos
# Predice la estructura de una proteína derivada de su secuencia de aminoácidos
gget alphafold MAAHKGAEHHHKAAEHHEQAAKHHHAAAEHHEKGEHEQAAHHADTAYAHHKHAEEHAAQAAKHDAEHHAPKPH

# Encuentra secuencias similares depositadas en el PDB para análisis comparativo
# Encuentra secuencias similares previamente depositadas en el PDB para análisis comparativo
gget blast --database pdbaa MAAHKGAEHHHKAAEHHEQAAKHHHAAAEHHEKGEHEQAAHHADTAYAHHKHAEEHAAQAAKHDAEHHAPKPH

# Busca los archivos del PDB por las proteínas encuentradas con gget blast para tener algo con que comparar la predicción
# Busca los archivos PDB de estructuras similares resultantes de gget blast para comparar y obtener una medida de calidad del modelo predecido.
gget pdb 3UQ3 -o 3UQ3.pdb
gget pdb 2K42 -o 2K42.pdb
```
```python
# Python
# Predice la estructura de una proteína basada sobre su secuencia de aminoácidos
# Predice la estructura de una proteína derivada de su secuencia de aminoácidos
gget.alphafold("MAAHKGAEHHHKAAEHHEQAAKHHHAAAEHHEKGEHEQAAHHADTAYAHHKHAEEHAAQAAKHDAEHHAPKPH")

# Encuentra secuencias similares depositadas en el PDB para análisis comparativo
# Encuentra secuencias similares previamente depositadas en el PDB para análisis comparativo
gget.blast("MAAHKGAEHHHKAAEHHEQAAKHHHAAAEHHEKGEHEQAAHHADTAYAHHKHAEEHAAQAAKHDAEHHAPKPH", database="pdbaa")

# Busca los archivos del PDB por las proteínas encuentradas con gget blast para tener algo con que comparar la predicción
# Busca los archivos PDB de estructuras similares resultantes de gget blast para comparar y obtener una medida de calidad del modelo predecido.
gget.pdb("3UQ3", save=True)
gget.pdb("2K42", save=True)
```
→ `gget alphafold` devuelve la estructura pedicada (en formato PDB) y el errór de alineación (en formato json) en una carpeta nueva ("./[fecha_tiempo]_gget_alphafold_prediction"). Este ejemplo demuestra como usar [`gget blast`](blast.md) y [`gget pdb`](pdb.md) para correr un análisis comparativo. Los archivos PDB se pueden ver en 3D con [RCSB 3D view](https://rcsb.org/3d-view), o usando programas como [PyMOL](https://pymol.org/) o [Blender](https://www.blender.org/). Para comparar múltiple archivos PDB, usen [RCSB alignment](https://rcsb.org/alignment). Python también devuelve [visualizaciónes interactivas](https://twitter.com/NeuroLuebbert/status/1555968042948915200), que también se pueden generar con los archivos PDB y JSON como describido en [gget alphafold FAQ](https://github.com/pachterlab/gget/discussions/39) Q4.
→ `gget alphafold` produce la estructura predecida (en formato PDB) y el errór de alineación (en formato json) en una nueva carpeta ("./[fecha_tiempo]_gget_alphafold_prediction"). Este ejemplo demuestra como usar [`gget blast`](blast.md) y [`gget pdb`](pdb.md) para correr un análisis comparativo. Los archivos PDB se pueden ver en 3D con [RCSB 3D view](https://rcsb.org/3d-view), o usando programas como [PyMOL](https://pymol.org/) o [Blender](https://www.blender.org/). Para comparar múltiples archivos PDB, use [RCSB alignment](https://rcsb.org/alignment). Python también produce [esquemas interactivos](https://twitter.com/NeuroLuebbert/status/1555968042948915200), los cuales se pueden generar de los archivos PDB y JSON, como es describido en [gget alphafold FAQ](https://github.com/pachterlab/gget/discussions/39) Q4.

<iframe width="560" height="315" src="https://www.youtube.com/embed/4qxGF1tbZ3I?si=mEqQ5oSnDYtg2OP7" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" allowfullscreen></iframe>

Expand Down
38 changes: 19 additions & 19 deletions docs/src/es/archs4.md
Original file line number Diff line number Diff line change
@@ -1,50 +1,50 @@
> Parámetros de Python són iguales a los parámetros largos (`--parámetro`) de Terminal, si no especificado de otra manera. 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`.
> Parámetros de Python són iguales a los parámetros largos (`--parámetro`) de Terminal, si no es especificado de otra manera. Las banderas son designadas como cierto o falso (True/False) en Python. El manuál para cualquier modulo de gget se puede obtener desde Terminal con la bandera `-h` `--help`.
## gget archs4 🐁
Encuentra los genes más correlacionados a un gen de interés o encuentra los tejidos donde se expresa un gen usando la base de datos [ARCHS4](https://maayanlab.cloud/archs4/).
Regresa: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python).
Encuentra los genes más correlacionados a un gen de interés, o bién, encuentra los tejidos donde un gen se expresa usando la base de datos [ARCHS4](https://maayanlab.cloud/archs4/).
Produce: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python).

**Parámetro posicional**
`gene`
Nombre corto (símbolo del gen) del gen de interés, p. ej. STAT4.
Alternativamente: usa la bandera `--ensembl` para ingresar un ID del tipo Ensembl, p. ej. ENSG00000138378.
Alternativamente: usa la bandera `--ensembl` para ingresar un ID tipo Ensembl, p. ej. ENSG00000138378.

**Parámetros optionales**
`-w` `--which`
'correlation' (correlación; esto se usa por defecto) o 'tissue' (tejido).
'correlation' regresa una tabla que contiene los 100 genes más correlacionados con el gen de interés. La correlación de Pearson se calcula sobre todas las muestras y tejidos en [ARCHS4](https://maayanlab.cloud/archs4/).
'tissue' regresa un atlas de expresión tisular calculado sobre todas las muestras humanas o de ratón (según lo definido usando el parámetro `--species` (especies)) en [ARCHS4](https://maayanlab.cloud/archs4/).
'correlation' (correlación; se usa por defecto) o 'tissue' (tejido).
'correlation' produce una tabla que contiene los 100 genes más correlacionados con el gen de interés. La correlación de Pearson se calcula de todas las muestras y tejidos en [ARCHS4](https://maayanlab.cloud/archs4/).
'tissue' produce un atlas de expresión tisular calculado de todas las muestras humanas o de ratón (según lo definido usando el parámetro `--species` (especies)) en [ARCHS4](https://maayanlab.cloud/archs4/).

`-s` `--species`
'human' (humano; esto se usa por defecto) o 'mouse' (ratón).
Define si usar muestras humanas o de ratón de [ARCHS4](https://maayanlab.cloud/archs4/).
(Solo aplicable para el atlas de expresión tisular.)
'human' (humano; se usa por defecto) o 'mouse' (ratón).
Define si se usan muestras humanas o de ratón de [ARCHS4](https://maayanlab.cloud/archs4/).
(Solo aplica para el atlas de expresión tisular.)

`-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.
Para Python, use `save=True` para guardar los resultados en el directorio de trabajo actual.

**Banderas**
`-e` `--ensembl`
Usa esta bandera si `gene` se ingresa como ID del tipo Ensembl.
Usa esta bandera si `gene` se ingresa como ID tipo Ensembl.

`-csv` `--csv`
Solo para la Terminal. Regresa los resultados en formato CSV.
Para Python, usa `json=True` para regresar los resultados en formato JSON.
Solo para Terminal. Produce los resultados en formato CSV.
Para Python, usa `json=True` para obtener los resultados en formato JSON.

`-q` `--quiet`
Solo para la Terminal. Impide la informacion de progreso de ser exhibida durante la corrida.
Para Python, usa `verbose=False` para imipidir la informacion de progreso de ser exhibida durante la corrida.
Solo para Terminal. Impide la información de progreso de ser exhibida durante la ejecución del programa.
Para Python, usa `verbose=False` para impedir la información de progreso de ser exhibida durante la ejecución del programa.


### Por ejemplo
### Ejemplo
```bash
gget archs4 ACE2
```
```python
# Python
gget.archs4("ACE2")
```
&rarr; Regresa los 100 genes más correlacionados con el gen ACE2:
&rarr; Produce los 100 genes más correlacionados con el gen ACE2:

| gene_symbol | pearson_correlation |
| -------------- |-------------------------|
Expand All @@ -61,7 +61,7 @@ gget archs4 -w tissue ACE2
# Python
gget.archs4("ACE2", which="tissue")
```
&rarr; Regresa la expresión tisular de ACE2 (por defecto, se utilizan datos humanos):
&rarr; Produce la expresión tisular de ACE2 (por defecto, se utilizan datos humanos):

| id | min | q1 | median | q3 | max |
| ------ |--------| ------ |--------| ------ |--------|
Expand Down
18 changes: 9 additions & 9 deletions docs/src/es/blast.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
> Parámetros de Python són iguales a los parámetros largos (`--parámetro`) de Terminal, si no especificado de otra manera. 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`.
> 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 blast 💥
BLAST una secuencia de nucleótidos o aminoácidos a cualquier base de datos [BLAST](https://blast.ncbi.nlm.nih.gov/Blast.cgi).
Regresa: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python).
Produce: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python).

**Parámetro posicional**
`sequence`
Expand All @@ -18,7 +18,7 @@ Por defecto: 'nt' para secuencias de nucleótidos; 'nr' para secuencias de amino
[Más información sobre los bases de datos BLAST](https://ncbi.github.io/blast-cloud/blastdb/available-blastdbs.html)

`-l` `--limit`
Limita el número de resultados para regresar. Por defecto: 50.
Limita el número de resultados producidos. Por defecto: 50.

`-e` `--expect`
Define el umbral de ['expect value'](https://blast.ncbi.nlm.nih.gov/Blast.cgi?CMD=Web&PAGE_TYPE=BlastDocs&DOC_TYPE=FAQ#expect). Por defecto: 10.0.
Expand All @@ -35,12 +35,12 @@ Activa el ['low complexity filter'](https://blast.ncbi.nlm.nih.gov/Blast.cgi?CMD
Desactiva el algoritmo MegaBLAST. Por defecto: MegaBLAST esta activado (solo aplicable para blastn).

`-csv` `--csv`
Solo para la Terminal. Regresa los resultados en formato CSV.
Para Python, usa `json=True` para regresar los resultados en formato JSON.
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 la Terminal. Impide la informacion de progreso de ser exhibida durante la corrida.
Para Python, usa `verbose=False` para imipidir la informacion de progreso de ser exhibida durante la corrida.
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.

`wrap_text`
Solo para Python. `wrap_text=True` muestra los resultados con texto envuelto para facilitar la lectura (por defecto: False).
Expand All @@ -53,7 +53,7 @@ gget blast MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQ
# Python
gget.blast("MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR")
```
&rarr; Regresa los resultados BLAST de la secuencia de interés. `gget blast` automáticamente detecta esta secuencia como una secuencia de aminoácidos y, por lo tanto, establece el programa BLAST en *blastp* con la base de datos *nr*.
&rarr; Produce los resultados BLAST de la secuencia de interés. `gget blast` automáticamente detecta esta secuencia como una secuencia de aminoácidos y, por lo tanto, establece el programa BLAST en *blastp* con la base de datos *nr*.

| Description | Scientific Name | Common Name | Taxid | Max Score | Total Score | Query Cover | ... |
| -------------- |-------------------------| ------------------------| -------------- | ----------|-----|---|---|
Expand All @@ -69,6 +69,6 @@ gget blast fasta.fa
# Python
gget.blast("fasta.fa")
```
&rarr; Regresa los resultados BLAST de la primera secuencia contenida en el archivo 'fasta.fa'.
&rarr; Produce los resultados BLAST de la primera secuencia contenida en el archivo 'fasta.fa'.

#### [Más ejemplos](https://github.com/pachterlab/gget_examples)
17 changes: 8 additions & 9 deletions docs/src/es/blat.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
> Parámetros de Python són iguales a los parámetros largos (`--parámetro`) de Terminal, si no especificado de otra manera. 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 blat 🎯
Encuentra la ubicación genómica de una secuencia de nucleótidos o aminoácidos usando [BLAT](https://genome.ucsc.edu/cgi-bin/hgBlat).
Regresa: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python).
Produce: Resultados en formato JSON (Terminal) o Dataframe/CSV (Python).

**Parámetro posicional**
`sequence`
Expand All @@ -13,8 +13,7 @@ Secuencia de nucleótidos o aminoácidos, o una ruta a un archivo tipo FASTA o .
Por defecto: 'DNA' para secuencias de nucleótidos; 'protein' para secuencias de aminoácidos.

`-a` `--assembly`
Ensamblaje del genoma. 'human' (hg38) (esto se usa por defecto), 'mouse' (mm39) (ratón), 'zebrafinch' (taeGut2) (
pinzón cebra),
Ensamblaje del genoma. 'human' (hg38) (se usa por defecto), 'mouse' (mm39) (ratón), 'zebrafish' (taeGut2) (pinzón cebra),
o cualquiera de los ensamblajes de especies disponibles [aquí](https://genome.ucsc.edu/cgi-bin/hgBlat) (use el nombre corto del ensamblado, p. ej. 'hg38').

`-o` `--out`
Expand All @@ -23,23 +22,23 @@ Para Python, usa `save=True` para guardar los resultados en el directorio de tra

**Banderas**
`-csv` `--csv`
Solo para la Terminal. Regresa los resultados en formato CSV.
Para Python, usa `json=True` para regresar los resultados en formato JSON.
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 la Terminal. Impide la informacion de progreso de ser exhibida durante la corrida.
Para Python, usa `verbose=False` para imipidir la informacion de progreso de ser exhibida durante la corrida.
Solo para Terminal. Impide la información de progreso de ser exhibida durante la ejecución del programa.
Para Python, usa `verbose=False` para impedir la información de progreso de ser exhibida durante la ejecución del programa.


### Por ejemplo
### Ejemplo
```bash
gget blat -a taeGut2 MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR
```
```python
# Python
gget.blat("MKWMFKEDHSLEHRCVESAKIRAKYPDRVPVIVEKVSGSQIVDIDKRKYLVPSDITVAQFMWIIRKRIQLPSEKAIFLFVDKTVPQSR", assembly="taeGut2")
```
&rarr; Regresa los resultados de BLAT para el ensamblaje taeGut2 (pinzón cebra). En este ejemplo, `gget blat` automáticamente detecta esta secuencia como una secuencia de aminoácidos y, por lo tanto, establece el tipo de secuencia (`--seqtype`) como *proteína*.
&rarr; Produce los resultados de BLAT para el ensamblaje taeGut2 (pinzón cebra). En este ejemplo, `gget blat` automáticamente detecta esta secuencia como una secuencia de aminoácidos y, por lo tanto, establece el tipo de secuencia (`--seqtype`) como *proteína*.

| genome | query_size | aligned_start | aligned_end | matches | mismatches | %_aligned | ... |
| -------------- |-------------------------| ------------------------| -------------- | ----------|-----|---|---|
Expand Down
Loading

0 comments on commit 6a42a35

Please sign in to comment.