Tutoriais

Fluxos reproduzíveis com OpenDataBio-R

Os tutoriais transformam os conceitos e guias de uso em fluxos reproduzíveis no R. Eles não substituem a referência da API: a referência define campos e parâmetros, enquanto o tutorial mostra como combiná-los para concluir uma tarefa.

Antes de começar

Para consultas públicas, normalmente basta a URL da API. Para acessar dados restritos ou modificar registros, você precisa de uma conta com as permissões corretas e de um token pessoal. Nunca publique esse token em scripts, repositórios ou relatórios.

Antes de importar dados, leia Primeira vez? e teste o fluxo com poucos registros. Use uma instalação de testes quando estiver aprendendo ou preparando operações destrutivas.

Leia também o Fluxo de importação de dados, que explica a ordem das dependências, a validação prévia de coordenadas e como reconciliar os resultados e IDs de cada UserJob com a tabela enviada.

Fluxos de trabalho com R

1. Obter e conferir dados

O tutorial Obter dados via R ensina a configurar a conexão e consultar taxons, localidades, indivíduos, medições, mídias, vouchers e datasets. Ele complementa o guia Pesquisar e mapear dados.

Ao concluir, você deve conseguir:

  • reproduzir no R uma consulta feita na interface;
  • escolher entre resposta direta e exportação em UserJob;
  • preservar identificadores e metadados necessários para relacionar tabelas;
  • transformar localidades em objetos espaciais e validar geometrias.

2. Preparar e importar dados

O tutorial Importar dados via R apresenta a ordem de dependências e exemplos por tipo de registro. Comece pelo índice e avance apenas pelas seções necessárias ao seu conjunto de dados.

Ao concluir, você deve conseguir:

  • verificar registros que já existem antes de criar novos;
  • montar data.frames com os campos definidos pela API;
  • importar bibliotecas compartilhadas antes dos dados dependentes;
  • acompanhar o UserJob e interpretar sucessos, avisos e erros;
  • consultar uma amostra dos registros importados para validar o resultado.

Sequência recomendada

  1. Configure a conexão sem escrever o token diretamente no script.
  2. Teste uma consulta pública.
  3. Reproduza filtros do Data Explorer no R.
  4. Consulte pessoas, referências, taxons, localidades e traits existentes.
  5. Prepare um lote pequeno.
  6. Importe na ordem indicada em Primeira vez?.
  7. Acompanhe o UserJob e examine os resultados por registro.
  8. Consulte novamente os dados e compare com a entrada.
  9. Só então processe o conjunto completo.

Mapa de melhoria dos tutoriais

Os exemplos existentes cobrem muitos modelos, mas foram escritos em momentos diferentes da evolução da API. A revisão deve seguir esta matriz:

PrioridadeMelhoriaCritério de conclusão
AltaSegurança do token e configuração por variáveis de ambienteNenhum exemplo contém token real ou recomenda salvá-lo no script.
AltaAtualizar saídas, nomes de campos e links para a API atualTodo código usa parâmetros presentes no schema e links válidos.
AltaExplicar UserJobs e resultados estruturadosCada importação mostra como conferir estado, avisos, erros e IDs afetados.
AltaCriar dados de exemplo pequenos e reproduzíveisExemplos não dependem de IDs específicos de uma instalação pública.
MédiaRelacionar Data Explorer, API e RPelo menos uma consulta é construída na interface e reproduzida em R.
MédiaCobrir datasets e versões publicadasExemplo diferencia exportação momentânea de download de versão citável.
MédiaAtualizar localidadesExemplo cobre GeoJSON, localidades marinhas, parcelas, transectos e posições relativas.
MédiaAtualizar identificaçõesExemplo distingue identificação atual, histórico de identificações e auditoria.
MédiaAcrescentar validação pós-importaçãoCada capítulo termina consultando e comparando registros criados.
FuturaFilogeniasCriar um fluxo separado quando houver suporte estável no cliente R.

Enquanto essa revisão não estiver completa, confirme sempre os campos na referência da API e execute os exemplos em lotes pequenos.

Como contribuir

Um tutorial deve declarar pré-requisitos, permissões necessárias, dados de entrada, resultado esperado e como desfazer ou corrigir uma execução de teste. Consulte Como contribuir antes de enviar um novo exemplo.


Obter dados via R

Obter dados com o pacote OpenDataBio-R

Importar dados via R

Importar dados com o pacote OpenDataBio-R

Última modificação July 10, 2026: Updated docs to odb version 0.10.0-alpha2 (886b968)