Melhorada documentação

covid-taskforce-cplp · Mar 26, 2020 · 6807652 · 6807652
1 parent f14fe9f
commit 6807652
Show file tree

Hide file tree

Showing 5 changed files with 108 additions and 18 deletions.
diff --git a/README.md b/README.md
@@ -1,5 +1,18 @@
 # calculadora-covid-por-pais
-[rascunho] Veja https://www.facebook.com/groups/coronaviruscplp/permalink/539215950056726/
+Visite [https://covid-taskforce-cplp.github.io/calculadora-covid-por-pais/](https://covid-taskforce-cplp.github.io/calculadora-covid-por-pais/)
+para ver o resultado.
+
+## Sobre o código
+
+### js/calculadora-inicializacao.js
+O [js/calculadora-inicializacao.js](js/calculadora-inicializacao.js)
+
+
+* Favor evitar refatorar as funcões de calculadora-logica.js de modo que fique
+* mais difícil para não-especialistas em JavaScript (ex.: pesquisadores
+*  academicos)
+
+(...)
 
 # Licença
 
@@ -21,4 +34,4 @@ Na medida do possível segundo a lei, tanto as pessoas
 [da idealização e apoio](https://www.facebook.com/groups/coronaviruscplp/)
 como as [desenvolvedoras do código](https://github.com/orgs/covid-taskforce-cplp/people)
 e renuciam a todos os direitos autorais e direitos conexos ou vizinhos a este
-trabalho para o [Domínio Público](UNLICENSE).
+trabalho para o [Domínio Público](UNLICENSE).
diff --git a/index.html b/index.html
@@ -29,22 +29,36 @@ <h1>covid-taskforce-cplp/calculadora-covid-por-pais v0.1.0</h1>
         </div>
         <div class="col-sm">
           <div class="form-group">
-            <label for="populacao-total">População</label>
+            <label for="populacao-total">População Total</label>
             <input type="number" class="form-control" id="populacao-total" aria-describedby="populacao-total-dica" placeholder="População total" value="209300000">
             <small id="populacao-total-dica" class="form-text text-muted">Informe a população total da região. Ex.: 209.300.000 é população do 🇧🇷 Brasil</small>
           </div>
         </div>
       </div>
 
-      <div class="form-group">
-        <label for="populacao-infectada-percentual">População infectada (%)</label>
-        <input type="number" class="form-control" id="populacao-infectada-percentual" aria-describedby="populacao-infectada-percentual-dica" placeholder="População total" value="60">
-        <small id="populacao-infectada-percentual-dica" class="form-text text-muted">Valor de 0 a 100. Representa o % de da população total que <em>no final</em> da epidemia na região teria sido contamidana</small>
-      </div>
-      <div class="form-group">
-        <label for="epidemia-letalidade-media">Letalidade infecção</label>
-        <input type="number" class="form-control" id="epidemia-letalidade-media" aria-describedby="epidemia-letalidade-media-dica" placeholder="Informe um percentual" value="1">
-        <small id="epidemia-letalidade-media-dica" class="form-text text-muted">Informe um percentual. Aceita virgulas e pontos como separador</small>
+      <div class="row">
+        <div class="col-sm">
+          <div class="form-group">
+            <label for="populacao-infectada-percentual-sugestao">População infectada (%) pré-definidas</label>
+            <select class="form-control" id="populacao-infectada-percentual-sugestao" aria-describedby="populacao-infectada-percentual-dica" disabled>
+              <option>Customizado</option>
+              <option>🇧🇷 Brasil</option>
+            </select>
+            <small id="populacao-infectada-percentual-sugestao-dica" class="form-text text-muted">Estimativas sugeridas conforme relatórios oficiais</small>
+          </div>
+        </div>
+        <div class="col-sm">
+          <div class="form-group">
+            <label for="populacao-infectada-percentual">População infectada (%)</label>
+            <input type="number" class="form-control" id="populacao-infectada-percentual" aria-describedby="populacao-infectada-percentual-dica" placeholder="População total" value="60">
+            <small id="populacao-infectada-percentual-dica" class="form-text text-muted">Valor de 0 a 100. Representa o % de da população total que <em>no final</em> da epidemia na região teria sido contamidana</small>
+          </div>
+          <div class="form-group">
+            <label for="epidemia-letalidade-media">Letalidade infecção</label>
+            <input type="number" class="form-control" id="epidemia-letalidade-media" aria-describedby="epidemia-letalidade-media-dica" placeholder="Informe um percentual" value="1">
+            <small id="epidemia-letalidade-media-dica" class="form-text text-muted">Informe um percentual. Aceita virgulas e pontos como separador</small>
+          </div>
+        </div>
       </div>
       <!-- <button type="submit" class="btn btn-primary">Submit</button> -->
       <div>
@@ -58,6 +72,38 @@ <h1>covid-taskforce-cplp/calculadora-covid-por-pais v0.1.0</h1>
       </div>
     </form>
     <hr />
+    <div>
+      <h2 id="referencias">Referências</h2>
+      <h3>Estimativas de impacto</h3>
+      <table class="table">
+        <thead>
+          <tr>
+            <th scope="col">#</th>
+            <th scope="col">Organização</th>
+            <th scope="col">Título</th>
+            <th scope="col">Comentários</th>
+          </tr>
+        </thead>
+        <tbody>
+          <tr>
+            <th scope="row">1</th>
+            <td>Imperial College COVID-19 Response Team</td>
+            <td>
+              <a href="https://www.imperial.ac.uk/media/imperial-college/medicine/sph/ide/gida-fellowships/Imperial-College-COVID19-NPI-modelling-16-03-2020.pdf">
+                Impact of non-pharmaceutical interventions (NPIs) to reduce COVID19 mortality and healthcare demand
+              </a>
+            </td>
+            <td></td>
+          </tr>
+        </tbody>
+      </table>
+      <h3>Referências de modelos matemáticos</h3>
+      <p><em>TODO: adicionair mais informações</em></p>
+      <!--
+        https://en.wikipedia.org/wiki/Mathematical_modelling_of_infectious_disease
+      -->
+    </div>
+    <hr />
     <div class="alert alert-secondary" role="alert">
       Discussão em <a href="https://www.facebook.com/groups/coronaviruscplp/permalink/539215950056726/">https://www.facebook.com/groups/coronaviruscplp/permalink/539215950056726/</a>
       <sup>(requer convite, fale com membros antes)</sup>. <br>

diff --git a/js/calculadora-inicializacao.js b/js/calculadora-inicializacao.js
@@ -1 +1,17 @@
-console.log('calculadora-inicializacao.js pode ser usada para pre-carregar dados e setar variaveis que poderiam ser reusadas pelo calculadora-logica.js ficar simples para edição por desenvolvedores não especialista em javascript')
+/**
+* O arquivo calculadora-inicializacao.js foi criado para, caso necessário,
+* conter conter qualquer rotina que seja necessária por calculadora-logica.js
+* e calculadora-ui.js.
+*
+* Um ótimo exemplo seria pré-carregar dados de algum web service e/ou arquivo
+* json externo com dados atualizados de pais. Também pode servir para permitir
+* que uma pessoa editando apenas o HTML de uma pasta local sem inicializar um
+* servidor http não tenha problemas com CORS, arquivos não carregados, etc.
+*
+* NOTA: este arquivo não precisa ser amigável. Pode ter gambiarra. É livre setar
+*       variavel global aqui.
+*
+* @license PUBLIC DOMAIN
+*/
+
+console.log('calculadora-inicializacao.js carregado');
diff --git a/js/calculadora-logica.js b/js/calculadora-logica.js
@@ -1,12 +1,15 @@
 /**
 * Arquivo com funções escritas em JavaScript com cálculos principais.
-* Favor evitar refatorar as funcões de calculadora-logica.js de modo que fique
-* mais difícil para não-especialistas em JavaScript (ex.: pesquisadores
-*  academicos)
 *
-* @license Public Domain
+* JAVASCRITP BÁSICO: https://developer.mozilla.org/pt-BR/docs/Aprender/Getting_started_with_the_web/JavaScript_basico
+* VIDEO:             [[TODO: adicionar algum vídeo de ajuda sobre JavaScript aqui]] (fititnt, 2020-03-26 17:11 BRT)
+*
+*
+* @license PUBLIC DOMAIN
 */
 
+console.log('calculadora-logica.js carregado');
+
 /**
  * Simulação mais simplificada possível de, para uma data população total e
  * a chance da respectiva população ser infectada (por exemplo, simulando uma

diff --git a/js/calculadora-ui.js b/js/calculadora-ui.js
@@ -1,8 +1,20 @@
-console.log('calculadora-ui.js pode ser usada para, ao consumir calculadora-logica.js, manipilar interface de usuario')
+/**
+* O calculadora-ui.js abstrai a comunicação entre o index.html e o
+* calculadora-logica.js.
+*
+* Embora ele não precise ser tão amigável quanto o calculadora-logica.js, a
+* escolha de usar jQuery é para facilitar forks ou se alguma pessoa pesquisadora
+* quiser contrubuir com a interface também.
+*
+* @license PUBLIC DOMAIN
+*/
+
+console.log('calculadora-ui.js carregado');
 
 var populacaoTotal = jQuery('#populacao-total').val().replace(/[^0-9]/g, '');
 var populacaoInfectadaPercentual = jQuery('#populacao-infectada-percentual').val();
 var letalidadeInfeccao = jQuery('#epidemia-letalidade-media').val();
+
 console.log(populacaoTotal, populacaoInfectadaPercentual, letalidadeInfeccao);
 
 // https://blog.abelotech.com/posts/number-currency-formatting-javascript/