Data

Tools

Indexes

Applications

Experiments

Open Source Science

repo-program-template

This is a repository template for internal programs developed in the Program of Computational Genomics

https://github.com/computational-genomics-research-program/repo-program-template

Science Score: 44.0%

This score indicates how likely this project is to be science-related based on various indicators:

  • ✓
    CITATION.cff file
    Found CITATION.cff file
  • ✓
    codemeta.json file
    Found codemeta.json file
  • ✓
    .zenodo.json file
    Found .zenodo.json file
  • ○
    DOI references
  • ○
    Academic publication links
  • ○
    Academic email domains
  • ○
    Institutional organization owner
  • ○
    JOSS paper metadata
  • ○
    Scientific vocabulary similarity
    Low similarity (10.7%) to scientific vocabulary

Keywords

documentation template template-repository
Last synced: 6 months ago · JSON representation ·

Repository

This is a repository template for internal programs developed in the Program of Computational Genomics

Basic Info
  • Host: GitHub
  • Owner: Computational-Genomics-Research-Program
  • License: other
  • Default Branch: master
  • Size: 7.81 KB
Statistics
  • Stars: 0
  • Watchers: 1
  • Forks: 0
  • Open Issues: 0
  • Releases: 0
Topics
documentation template template-repository
Created over 5 years ago · Last pushed over 5 years ago
Metadata Files
Readme License Citation

README.md

[Program name]

Description

[High-level description, describing what exactly program does.]

Motivation

[Why the program does things the way it does and why it was designed in the first place. What problems are solved by it.]

System requirements

[If the program does make high demand on particular resources, then this should be clearly advertised and explained.]

Install

[This may be described in a separate INSTALL file, but the README must then clearly state this.]

Quick start

[How the first task can be performed with the program, or, in the more extensive documentation, a link to the quick start. Outlines how to quickly get started with the programa using a basic yet practical example]

License

[Defines the set of rules and conditions for people who want to use the software.]

Support contact information

[It should be clear where to go for support, for example a contact e-mail address]

Software quality checklist

[This may describe the state of the code, providing the necessary guidance on which aspects could be improved]

Accessibility

  • [ ] Version control system

Documentation

  • [ ] README file

Learnability

  • [ ] Quick start

Buildability

  • [ ] INSTALL file

Copyright & Licensing

  • [ ] LICENSE file

Portability

  • [ ] Multiple platforms

Supportability

  • [ ] E-mail address
  • [ ] Issue tracker

Analysability

  • [ ] Source code structured
  • [ ] Sensible names
  • [ ] Coding standards - style guides

Changeability

  • [ ] Code changes, and their authorship, publicly visible

Reusability

  • [ ] Source code set up in a modular fashion

Security & Privacy

  • [ ] Passwords must never be stored in unhashed form

Owner

  • Login: Computational-Genomics-Research-Program
  • Kind: user

Citation (CITATION.cff) 

cff-version: 1.1.0
message: If you use this software, please cite it as below.
authors:
  - name: RegulonDB
    country: MX
    email: regulondb@ccg.unam.mx
    website: http://regulondb.ccg.unam.mx/
date-released: YYYY-MM-DD
license: [GPL-3.0-only | Apache-2.0 | MIT ]
repository-code: [URL example: https://github.com/regulondbunam/Components]
title: [example: Components]
version: X.X.X

GitHub Events

Total
Last Year