diff --git a/.gitignore b/.gitignore index e48c49e..f2d4301 100644 --- a/.gitignore +++ b/.gitignore @@ -41,3 +41,4 @@ Thumbs.db ## Text Editors .vscode +.markdownlint.json \ No newline at end of file diff --git a/README.md b/README.md index 3f08407..3a780f8 100644 --- a/README.md +++ b/README.md @@ -16,7 +16,8 @@ was focused on the technical aspects of BrAPI and its potential. This manuscript ## Helpful Links + [Manuscript Content Folder](content) -+ [**HTML manuscript**](https://plantbreeding.github.io/BrAPI-Manuscript2/) -+ [**PDF manuscript**](https://plantbreeding.github.io/BrAPI-Manuscript2/manuscript.pdf) ++ [Markdown Formatting Cheat Sheet](content/formatting_help) ++ [HTML manuscript](https://plantbreeding.github.io/BrAPI-Manuscript2/) ++ [PDF manuscript](https://plantbreeding.github.io/BrAPI-Manuscript2/manuscript.pdf) + [Manubot README](Manubot-README.md) + [Manubot Usage Instructions](USAGE.md) diff --git a/content/02.introduction.md b/content/02.introduction.md index 37bf569..f26adc2 100644 --- a/content/02.introduction.md +++ b/content/02.introduction.md @@ -1,13 +1,35 @@ ## Introduction -The Breeding API (BrAPI) project is an effort to enable interoperability among plant breeding databases [@doi:10.1093/bioinformatics/btz190]. - + + + +Plant and animal breeding is an incredibly important part of today's society. Almost every country in the world has some kind of breeding program supporting the agricultural community to produce bigger, better, healthier, more sustainable crops. Modern breeding techniques require large amounts of high quality data to be effective. In the digital age, that breeding data is being collected, managed, and analyzed with computer software. Interoperability between breeding software tools, systems, and databases can substantially increase the efficiency of a breeding program. The ability to share tools gives each program a boost in computational power. The ability to share data means everyone has access to larger, more complete, datasets and get build more accurate computational models and produce more accurate predictions. + +The Breeding API (BrAPI) project is an effort to enable interoperability among breeding tools, systems, and databases. BrAPI is a standardized Representational State Transfer (REST), web service, Application Programming Interface (API), specification for breeding and related agricultural data. [@doi:10.1093/bioinformatics/btz190] By using the BrAPI standard, breeding software can more easily become interoperable, allowing groups to more easily share data and software tools. + +### How it works + +An Application Programming Interface (API) is a technical connection between two pieces of software. Just as a Graphical User Interface (GUI) or a Command Line Interface (CLI) allows a human user to interact with a piece of software, an API allows one software application to interact with another. A GUI or CLI might allow a user to input data, read data, and start processes within an application. An API allows one piece of software (sometimes called a client, user agent, or service consumer) to programmatically input data, read data, and start process within another piece of software (sometimes called a server or service provider). + +A Representational State Transfer (REST) web service is a type of API commonly used in today's modern web infrastructure. REST is a technical architecture that describes the stateless transmission of data between applications. Typically, REST systems are implemented using the standard HTTP protocol that most of the modern internet is built upon. REST implementations also generally use JavaScript Object Notation (JSON) to represent the data being transferred. Both HTTP and JSON are programming language agnostic, very stable, and very flexible. This means BrAPI can be implemented in almost any piece of software, and can solve a wide range of use cases. + +### Project Updates + +Over its lifetime, the BrAPI project has grown and changed substantially. The latest stable version of the specification (v2.1) looks vastly different from the original version (v1.0) 51 released in 2017. The total size of the specification has almost quadrupled in that time, going from 51 endpoints documented in v1.0 to 201 endpoints documented in v2.1. Because of this growth, the specification documents were reorganized into four modules: BrAPI-Core, BrAPI-Germplasm, BrAPI-Genotyping, and BrAPI-Phenotyping. Figure {@fig:domains}1 shows a simplified domain map of the whole BrAPI v2.1 data model, divided into the organizational modules. + +![Figure 1: A simplified domain map of the whole BrAPI data model, divided into organizational modules](images/BrAPI_Domains_v2-1_vertical.png){#fig:domains} + +### Community Growth + + diff --git a/content/03.success.md b/content/03.success.md index 0804d4c..c5a194b 100644 --- a/content/03.success.md +++ b/content/03.success.md @@ -2,17 +2,20 @@ 6+/- success stories highlighting BrAPI usefulness in breeding cycle -* Field Book for starting data collection - * Project Explanation - * BrAPI integration - * Layman description how it can help breeding program +### Field Book for starting data collection + +* Project Explanation +* BrAPI integration +* Layman description how it can help breeding program -* QBMS for the beginnings of analytics - * Project Explanation - * BrAPI integration - * Layman description how it can help breeding program +### QBMS for the beginnings of analytics + +* Project Explanation +* BrAPI integration +* Layman description how it can help breeding program -* [brapi sync](https://github.com/IntegratedBreedingPlatform/brapi-sync) - * Project Explanation - * BrAPI integration - * Layman description how it can help breeding program +### [brapi sync](https://github.com/IntegratedBreedingPlatform/brapi-sync) + +* Project Explanation +* BrAPI integration +* Layman description how it can help breeding program diff --git a/content/images/BrAPI_Domains_v2-1_vertical.png b/content/images/BrAPI_Domains_v2-1_vertical.png new file mode 100644 index 0000000..90f6f52 Binary files /dev/null and b/content/images/BrAPI_Domains_v2-1_vertical.png differ