Checklist │Curadoria de metadados de dados de investigação

1 Checklist │Curadoria de metadados de dados de investigação Etapa Check (Conferir) Ação de curadoria Sim Não ? N/A Confirmar se todos os dados e metadados requeridos pelo sistema para publicar o conjunto de dados com sucesso estão presentes, bem como a documentação de apoio. ☐ ☐ ☐ ☐ O conjunto de dados foi submetido na coleção adequada. ☐ ☐ ☐ ☐ Verificaram-se problemas de licenciamento ou de direitos de propriedade intelectual relacionados com o conjunto de dados. ☐ ☐ ☐ ☐ Os dados contêm informação sensível. ☐ ☐ ☐ ☐ ☐ Solicitar formulário de consentimento / acordo de participação. ☐ ☐ ☐ ☐ A documentação de apoio está incluída (codebook, data dictionary, metodologia, ficheiro Readme, etc.). ☐ ☐ ☐ ☐ Os campos de metadados obrigatórios estão preenchidos e são precisos. Etapa Understand (Compreender) Ação de curadoria Sim Não ? N/A Documentação de apoio detalhada, correta e completa: Garantir que o conjunto de dados está bem descrito e que os utilizadores finais terão uma ideia clara a que se referem os dados e como podem ser utilizados. ☐ ☐ ☐ ☐ Informação de contexto sobre os dados (como os dados foram recolhidos ou produzidos, o objetivo da investigação). ☐ ☐ ☐ ☐ Nomeação e estruturação adequada de ficheiros e pastas. ☐ ☐ ☐ ☐ Informações sobre confidencialidade e quaisquer restrições impostas ao uso dos dados. ☐ ☐ ☐ ☐ Nomes de descritores e variáveis, informações sobre valores permitidos e unidades de medida, códigos e classificações, se aplicável. ☐ ☐ ☐ ☐ Descrição do ambiente computacional necessário para executar qualquer código incluído (sistema operativo, pacotes de software e dependências). 2 Sim Não ? N/A Ficheiros corretamente abertos e conteúdos disponibilizados de forma adequada: ☐ ☐ ☐ ☐ Os ficheiros são abertos conforme esperado e os formatos de ficheiros compactados são extraídos sem problemas. Software desconhecido, versões incompatíveis ou impossibilidade de acesso ao software podem ser motivos para que os ficheiros não possam ser executados. ☐ ☐ ☐ ☐ Se os ficheiros não estiverem acessíveis, o investigador forneceu uma versão não proprietária dos mesmos? ☐ ☐ ☐ ☐ Se os ficheiros não proprietários não puderem ser fornecidos, o ficheiro Readme descreve como os dados foram gerados e o software necessário para os usar? ☐ ☐ ☐ ☐ O conteúdo do ficheiro é consistente com a estrutura e a codificação esperadas. O ficheiro Readme descreve os ficheiros de dados e inclui: ☐ ☐ ☐ ☐ Breve descrição ☐ ☐ ☐ ☐ Formatos de ficheiro (sinalizados se proprietários) ☐ ☐ ☐ ☐ Tamanho do ficheiro ☐ ☐ ☐ ☐ Caminho e/ou estrutura em árvore ☐ ☐ ☐ ☐ Um checksum que pode ser usado para verificar a integridade dos dados (por exemplo: md5, sha256) Sim Não ? N/A Ficheiros e pastas são nomeados e estruturados adequadamente: ☐ ☐ ☐ ☐ Os nomes dos ficheiros não contêm espaços ou caracteres especiais e usam underscores ou hífens como delimitadores (por exemplo, Datacollection_20201009_v02.csv). ☐ ☐ ☐ ☐ Os nomes dos ficheiros e diretórios são concisos, consistentes e compreensíveis. ☐ ☐ ☐ ☐ As datas nos nomes dos ficheiros usam uma formatação consistente (por exemplo, AAAAMMDD). 3 ☐ ☐ ☐ ☐ Os nomes dos ficheiros usam zeros à esquerda para números de versão (por exemplo, v_012). ☐ ☐ ☐ ☐ Os ficheiros estão agrupados numa estrutura de pastas lógica e não estão excessivamente aninhados. Nota: A estrutura de pastas pode depender do código, sintaxe ou output de um software. Sim Não ? N/A O código está bem comentado e produz os resultados esperados ☐ ☐ ☐ ☐ Se o conjunto de dados incluir software ou código... ☐ ☐ ☐ ☐ O código também está disponível no GitLab, GitHub, Bitbucket ou noutro repositório específico? ▪ Se sim, considerar pedir ao investigador para arquivá-lo no Software Heritage archive19 ou no Zenodo20 e ligá-lo através dos metadados do registo do conjunto de dados. ▪ Se não, e o investigador incluiu mais do que scripts de processamento ou análise de dados (como arquivos .r, .m ou .do), considerar sugerir um repositório específico. ☐ ☐ ☐ ☐ O código (ou parte do código) é proveniente de outra fonte? ☐ ☐ ☐ ☐ Se o código for proveniente de outra fonte, o código fonte original permite redistribuição? A licença é compatível com a licença da fonte original? ☐ ☐ ☐ ☐ Se executado, o código do software produz os resultados esperados sem erros? ☐ ☐ ☐ ☐ Se estiver incluído um ficheiro executável, o código-fonte também está disponível? ☐ ☐ ☐ ☐ O código está bem comentado: ▪ O código contém informações de cabeçalho como: autor, número da versão, nome do ficheiro, licença ▪ A função ou finalidade do código é clara (a partir do ficheiro Readme e/ou da descrição incluída) ▪ Se aplicável, o depositante incluiu informações sobre como executar o código 4 ▪ Os pacotes de software e dependências necessários estão listados ▪ Os comentários são concisos e claros e descrevem a intenção da(s) linha(s) de código que estão a seguir, OU ▪ O código em si é expressivo (pode ser entendido por humanos e máquinas) ☐ ☐ ☐ ☐ O ficheiro Readme ou um cabeçalho no próprio código inclui informações sobre: ▪ A licença. ▪ O nome do autor e informações de contacto. ▪ A versão e a data em que o código foi modificado e/ou executado pela última vez. ▪ Quaisquer fontes das quais o código (ou parte do código) é proveniente. ▪ Informações sobre o input necessário e o output esperado. ▪ Instruções sobre como instalar ou usar o código. Se houver vários ficheiros de script, a ordem segundo a qual os mesmos são executados deve ser clara. ▪ Pacotes de software e dependências necessários. ▪ Informações sobre o ambiente em que o código foi desenvolvido e/ou pode ser utilizado. Sim Não ? N/A A submissão contém dados potencialmente sensíveis **** ☐ ☐ ☐ ☐ O conjunto de dados inclui informações sobre: ▪ Participantes humanos (entrevistas, respostas a questionários/inquéritos, dados biomédicos e relacionados com questões de saúde, etc.) ▪ Temas/assuntos indígenas ▪ Menores ou pessoas incapazes de fornecer consentimento informado ▪ Espécies vulneráveis ▪ Propriedades protegidas/privadas ▪ Conteúdos ilegais/ofensivos ▪ Qualquer outro conteúdo que possa ser potencialmente sensível ou que 5 viole claramente os termos de uso do repositório. ☐ ☐ ☐ ☐ Em caso afirmativo, verificar se pelo menos um dos seguintes documentos está incluído: ▪ Formulário de consentimento ▪ Acordo de participação ▪ Acordo de partilha de dados ▪ Qualquer outro documento que descreva a permissão para disponibilizar dados para uso secundário. ☐ ☐ ☐ ☐ O formulário de consentimento ou acordo de partilha de dados inclui linguagem que permite ao investigador partilhar os dados num repositório. ☐ ☐ ☐ ☐ Se os dados só podem ser partilhados sob um conjunto específico de circunstâncias, o investigador selecionou os mecanismos apropriados para restringir o acesso. Nota: alguns servidores de repositórios não são criptografados, não devendo, por isso, ser usados para armazenar dados identificáveis de pessoas. Sim Não ? N/A A submissão contém dados ou código de outras fontes ☐ ☐ ☐ ☐ O conjunto de dados contém informações proprietárias ou restritas. Exemplo: dados ou código comercialmente licenciados ou proprietários ou dados de terceiros que só são acessíveis através de registo ou login. ☐ ☐ ☐ ☐ Dados ou código de terceiros foram devidamente citados e os termos de uso originais permitem a sua redistribuição. ☐ ☐ ☐ ☐ Um acordo de partilha de dados é referenciado ou incluído, permitindo que as informações sejam redistribuídas. 6 Etapa Recommend (Recomendar) Ação de curadoria Solicitar informações adicionais ao depositante ou sugerir alterações aos metadados e ficheiros, de forma a potenciar a descoberta e a utilização dos dados de acordo com os princípios FAIR. Etapa Augment (Aperfeiçoar) Ação de curadoria Sim Não ? N/A Os metadados são ricos, precisos e exaustivos Solicitar informações adicionais ao depositante ou sugerir alterações aos metadados e ficheiros, de forma a potenciar a descoberta e a utilização dos dados de acordo com os princípios FAIR. ☐ ☐ ☐ ☐ O conjunto de dados tem um título descritivo. ☐ ☐ ☐ ☐ Os termos e acrónimos são definidos. ☐ ☐ ☐ ☐ Os metadados estão livres de jargões (para a legibilidade humana) e de símbolos (para a legibilidade por máquina) ☐ ☐ ☐ ☐ A linguagem nos campos dos metadados descritivos é rigorosa e específica ☐ ☐ ☐ ☐ O campo Palavra-chave inclui termos que descrevem o conjunto de dados ☐ ☐ ☐ ☐ O campo Classificação do tópico/assunto inclui termos que descrevem o conjunto de dados ☐ ☐ ☐ ☐ Cada termo é inserido no seu próprio campo (ou seja, um termo por cada caixa) ☐ ☐ ☐ ☐ Os termos são provenientes de um vocabulário controlado (ou seja, os subcampos Vocabulário e URL do vocabulário estão preenchidos) Sim Não ? N/A Links relacionados com publicações, conjunto de dados e outros recursos devem ser incluídos ☐ ☐ ☐ ☐ Os campos e subcampos das Publicações relacionadas (Citação, Tipo de identificador, Número do identificador, URL) têm a descrição completa ☐ ☐ ☐ ☐ Qualquer conjunto de dados relacionado é registado no campo Conjuntos de dados relacionados 7 ☐ ☐ ☐ ☐ Os links para outros recursos publicados, tais como modelos associados ou código, documentação, instrumento de pesquisa, estudo de levantamento, planos de análise, plano de gestão de dados, etc., são adicionados no campo Outras referências. Os campos e subcampos sobre informação de financiamento são exaustivos e completos (Agência de financiamento e Número da bolsa/projeto) O campo da Origem dos dados está completo Etapa Transform (Converter) Ação de curadoria Sim Não ? N/A Os formatos de ficheiro são abertos ou estão bem documentados Assegurar que o conjunto de dados utiliza o maior número possível de formatos abertos e de uso generalizado. ☐ ☐ ☐ ☐ O conjunto de dados contém ficheiros com formatos proprietários ou inapropriados para preservação? ☐ ☐ ☐ ☐ Os ficheiros proprietários podem ser transformados em formatos nãoproprietários sem que ocorra perda de informação? Caso os ficheiros não possam ser transformados, a sua documentação descreve: ☐ ☐ ☐ ☐ O formato e o conteúdo dos ficheiros? ☐ ☐ ☐ ☐ O software ou instrumento que gerou os ficheiros? ☐ ☐ ☐ ☐ O software necessário para apresentar ou manipular os ficheiros? ☐ ☐ ☐ ☐ Uma alternativa freeware para aceder aos ficheiros (se disponível)? ☐ ☐ ☐ ☐ A documentação descreve os dados, as fórmulas usadas, os cabeçalhos de colunas, os nomes de variáveis, etc. por forma a que os dados sejam usáveis. ☐ ☐ ☐ ☐ A documentação está num formato adequado (p. ex., PDF/A ou .txt). 8 Etapa Include (Incluir) Ação de curadoria Sim Não ? N/A Incluir identificadores persistentes sempre que possível Facilitar a reutilização, bem como a correta atribuição e creditação dos dados, incluindo os identificadores persistentes relevantes e as informações de licenciamento adequadas. ☐ ☐ ☐ ☐ O conjunto de dados é parte integrante de uma publicação ou complementa um outro recurso? ☐ ☐ ☐ ☐ Em caso afirmativo, o URL para citação ou identificador persistente está incluído na documentação e registo de metadados. Verifique que o URL redireciona para a localização correta. ☐ ☐ ☐ ☐ Estão incluídos identificadores relevantes do(s) autor(es) (por exemplo: ORCID). ☐ ☐ ☐ ☐ Está incluída informação relevante acerca do financiamento. ☐ ☐ ☐ ☐ O DOI atribuído pela plataforma de onde foi depositado o conteúdo está registado e redireciona para a página do conjunto de dados (caso a curadoria ocorra antes da publicação, só será possível confirmar este comportamento após a publicação). Sim Não ? N/A Revisão do licenciamento e termos de utilização do conjunto de dados ☐ ☐ ☐ ☐ O investigador já selecionou uma licença? ☐ ☐ ☐ ☐ Em caso afirmativo, qual a licença ou termos de uso selecionados ___________________ A informação depositada contém dados ou código fonte obtidos ou derivados de terceiros? ☐ ☐ ☐ ☐ Em caso afirmativo, qual a licença ou termos de uso atribuídos ao recurso original? ___________________ A licença selecionada pelo depositante é menos restritiva que os termos definidos pela fonte externa? ☐ ☐ ☐ ☐ Em caso afirmativo, contacte o depositante e sugira uma licença mais apropriada. ☐ ☐ ☐ ☐ Caso contrário, pode prosseguir com a licença selecionada pelo depositante. 9 ☐ ☐ ☐ ☐ Está contemplada a correta atribuição dos dados obtidos de terceiros ou derivados de conjunto de dados existentes? ☐ ☐ ☐ ☐ O ficheiro Readme inclui informação de citação adequada para o conjunto de dados depositado. Etapa Optimize (Otimizar) Ação de curadoria Avaliar a adequação do conjunto de dados aos princípios FAIR e tomar medidas para melhorar a descoberta, acessibilidade, interoperabilidade e reutilização dos dados. Etapa Note Down (Registar) Ação de curadoria Certificar-se de que se faz um registo exato do trabalho de curadoria, documentando todas as ações e decisões associadas ao conjunto de dados. Link para registo digital: *Para determinar se um conjunto de dados tem dados sensíveis ou restrições de partilha de dados, as seguintes abordagens podem ser úteis: • Com base no título, descrição, palavras-chave e documentação, identificar se há potencial para que informações sensíveis sejam divulgadas no conjunto de dados. • Rever os formulários de consentimento para linguagem que impeça a partilha de dados. • Informar-se junto do investigador sobre a presença de informações sensíveis. Nota: se os investigadores tiverem de preencher um formulário com informações do conjunto de dados antes da submissão, essa pergunta pode ser incluída no referido formulário. • Abrir os ficheiros e procurar conteúdo sensível (por exemplo, informações de localização precisa de espécies e lugares protegidos, identificadores pessoais diretos e indiretos e outras informações que violem os termos de uso do repositório).