Como Usar
Linha de Comando
Tutorial Linha de Comando
Resumo de Comandos
Gerar Planilha de Scores
Para gerar a planilha de scores, é necessário fornecer um arquivo nos formatos .sdf,.smi ou .csv
Também é possível informar o caminho de uma pasta contendo os arquivos de entrada:
Atualizar Planilha de Scores para a Nova Versão
Essa funcionalidade não está mais disponível diretamente no rankadmet, mas pode ser acessada por meio de um programa auxiliar chamado lab2ai:
Tutorial Biblioteca
Instalação
Para instalar a biblioteca, acesse o repositório através deste link e baixe o arquivo .whl. Como se trata de uma biblioteca Python, você pode instalá-la utilizando o arquivo .whl com o comando pip install. Assim instalando em um ambiente virtual do seu projeto de desenvolvimento.
Como Usar
Como observado no quadro de fluxo geral, a biblioteca foi desenvolvida para otimizar esse fluxo descrito, abrangendo as etapas de preparação dos arquivos para envio aos sites do ADMETLab3.0 e swissadmet,e a geração da planilha de scores. No que diz respeito à obtenção da planilha do ADMET, essa etapa precisa ser realizada diretamente no site no caso do SwissADME. No entanto, no ADMETLab3.0, eles disponibilizam uma API, neste link, permitindo que seu código automatize também essa etapa.
Preparação
Essa parte consiste em ter como arquivo de entrada um .sdf que está muito grande para se colocar no admetlab, então ele será fracionado em varios sdf com 299 moleculas cada por padrão. Ou quando se tem um sdf e quer ter a lista de smiles das moleculas deste sdf para poder colocar em sites que aceitam apenas uma lista de smiles como o swissadmet. Essa etapa cria duas pastas a batchs, que tem os sdfs fracionados, e a addon, que tem a lista de smiles das moleculas do sdf.
# Os Parametos são:
# input_file: str -> Caminho do arquivo de entrada
# batch_size: int = 299 -> Tamanho do batch
# affinity_cutoff: float = None -> Filtro de afinidade
# no_batch: bool = False -> Flag para processar sem produzir os batchs apenas o addon
# verbose: bool = False -> Se True mostrar mensagens de log
# Caminho do arquivo
rankadmet.Addon().make_addon('arquivo.sdf',affinity_cutoff=-7)
# Para processar mais de um arquivo, basta colocar os caminhos dos arquivos numa lista
input = ['arquivo1.sdf', 'arquivo2.sdf']
# E interar sobre a lista
for i in input:
rankadmet.Addon().make_addon(i, affinity_cutoff=-7)
Planilhas ADMET: Obtenção das Análises ADMET
Etapa feita fora do programa, ela é necessária para se obter as análises ADMET das moléculas. Acesse o site ADMETlab 3.0 e processe os arquivos SDF criados individualmente. Já no SwissAdme o site recebe uma lista de smiles, que pode ser obtida pelo arquivo csv auxiliar que o rankadmet gera.
Envie os arquivos SDF ao Admetlab
Acesse o site AdmetLab 3.0 e envie os arquivos SDF menores gerados pelo Rankadmet que estão na pasta batchs.
Ou Coloque a Lista de Smiles no SwissAdme
Acesse o site SwissAdme e coloque a lista de smiles que se encontra no arquivo auxiliar na pasta addon.
Baixe os arquivos CSV
Baixe o csv da analise ADMET e o renomeie para corresponder ao arquivo que originou essa analise. Faça isso com todos, é uma maneira de manter organizado.
Criação da planilha de Scores
Após o download das análises, os arquivos obtidos podem ser utilizados para gerar a planilha de scores. O comando não apenas cria a planilha de scores, mas também gera uma planilha auxiliar contendo as 50 melhores moléculas. Esse número pode ser ajustado conforme necessário por meio de um parâmetro opcional.
A planilha de scores é acumulativa. Isso significa que, caso o usuário gere a planilha mais de uma vez, o programa concatenará os novos dados com os já existentes na planilha localizada na pasta onde está sendo executado. Em seguida, ela será classificada e ordenada da melhor para a pior molécula.
Além disso, é possível adicionar informações extras à planilha de scores utilizando um outro parâmetro opcional. Essas informações adicionais são extraídas de arquivos SDF, ou do CSV que estar na pasta "addon".
No quadro abaixo tem a lista de parametros e o que eles fazem, além de um exemplo
import pandas as pd
# Os Parametros são:
# input: str -> Caminho do arquivo de entrada
# addon: str = None -> Caminho do arquivo addon
# top_hits: int = 50 -> Quantidade de moleculas na planilha de melhores
# verbose: bool = False -> Se True mostrar mensagens de log
# Caminho do arquivo
rankadmet.Evaluate().admetlab('arquivo.csv', addon='addon.csv', top_hits=50, verbose=True)
# Ou DF
df = pd.read_csv('arquivo.csv')
df_addon = pd.read_csv('addon.csv')
rankadmet.Evaluate().admetlab(df, addon=df_addon, top_hits=50, verbose=True)
# Ou lista dos caminhos ou dfs
input = ['arquivo1.csv', 'arquivo2.csv']
for i in input:
rankadmet.Evaluate().admetlab(i, addon='addon.csv', top_hits=50, verbose=True)