Salta el contingut

L'informe descriptiu

Exercici descriptive-report-annex.pdf · PDF

Abans de baixar-te un joc, què llegeixes? La pàgina de la botiga. Què és, qui l'ha fet, quant ocupa la baixada, què diuen les ressenyes, si funciona a la teva màquina. Un minut, i decideixes.

Ara pensa en games_clean. Fa cinc setmanes que la neteges i una lliçó que la mesures. Saps que el preu té una cua, que nou jocs de cada deu no tenen Metascore, que "owners" és la part baixa d'un interval. Ningú més no ho sap. Si un company obre demà la teva taula, hi veu 26,685 files i cap avís.

Avui escrius la pàgina que els ho explica. És l'última peça de l'etapa "preparar": l'etiqueta de la caixa abans que vagi a les persones que construiran amb ella.

Què aprendràs

  • Què és un informe descriptiu i les sis parts que sempre té
  • Com convertir el resultat d'una consulta en una frase amb un nombre, una unitat i un significat
  • Com citar la font perquè algú altre pugui obtenir les mateixes dades un altre cop
  • Per què escrius la mediana en una columna asimètrica, i ho dius
  • Com escriure els límits d'un conjunt de dades: què no et pot dir
  • El parany: per què un informe no són tots els resultats de les teves consultes enganxats un darrere l'altre

La pàgina de botiga d'un conjunt de dades

Un informe descriptiu és un text curt que explica a algú que mai no ha obert un conjunt de dades què conté, d'on ve, com de bo és i per a què no es pot usar.

És la pàgina de botiga de les teves dades. La llegeixes abans d'"instal·lar" les dades en un gràfic. I com una pàgina de botiga, té sempre les mateixes seccions, perquè el lector sàpiga on mirar. Mantenim la pàgina de botiga durant tota la lliçó.

Part Pregunta que respon A la pàgina de botiga
1 · Font Qui l'ha recollit, on, quan? Qui l'ha netejat? Desenvolupador i data de llançament
2 · Mida Quantes files i columnes? Què és una fila? Quin període? Mida de la baixada
3 · Variables Quines són les columnes importants, el seu tipus i la seva unitat? Llista de característiques
4 · Qualitat Què falta, què és estimat o dubtós? Quant? Problemes coneguts
5 · Xifres clau Centre, dispersió i distribució del que importa Puntuació de les ressenyes i etiquetes
6 · Límits Què no et pot dir aquesta dada? Requisits del sistema: on no funcionarà
flowchart LR
    subgraph CTX ["Me'n puc fiar?"]
        direction TB
        P1["<b>1 · Font</b><br>qui, on, quan"] --> P2["<b>2 · Mida</b><br>files, columnes, període"] --> P3["<b>3 · Variables</b><br>columnes, tipus, unitats"]
    end
    subgraph FIG ["Què diu?"]
        direction TB
        P4["<b>4 · Qualitat</b><br>absent, estimat, dubtós"] --> P5["<b>5 · Xifres clau</b><br>centre, dispersió, distribució"]
    end
    subgraph LIM ["On s'atura?"]
        P6["<b>6 · Límits</b><br>què no et pot dir"]
    end
    CTX --> FIG --> LIM

Tot cap en 250 paraules. Aquest límit no és un càstig. És l'exercici.

Dos informes, les mateixes dades

Dos estudiants descriuen la mateixa taula. De quin et fiaries?

Informe A Informe B
"El conjunt de dades té molts jocs. La majoria són barats. El preu mitjà és 7.91. Falten algunes puntuacions. Els jocs són cada cop més populars." "26,685 jocs de Steam llançats 2004–2018. La meitat costen 4.99 USD o menys (mediana); la mitjana és 7.91 USD per uns quants productes de fins a 595.99 USD. Només el 10.7% té Metascore."

Ara assenyala les paraules exactes que marquen la diferència:

L'informe A diu L'informe B diu Què té B
"molts jocs" "26,685 jocs de Steam" Un recompte
(res) "llançats 2004–2018" Un període
"7.91" "7.91 USD" Una unitat
"el preu mitjà" "la meitat costen 4.99 USD o menys (mediana); la mitjana és 7.91 USD per..." Quin centre, i per què
"falten algunes puntuacions" "només el 10.7% té Metascore" Un percentatge
"els jocs són cada cop més populars" (res) Cap afirmació que no pugui provar

Aquesta darrera fila importa. La taula mostra 53 jocs llançats el 2004 i 8,845 el 2018. Són més jocs llançats. No són més jugadors: la taula no compta els jugadors en absolut. L'informe A va anar més enllà de les dades. L'informe B va saber on aturar-se.

Compte: un informe no és un registre

"Un informe són tots els resultats de les meves consultes enganxats un darrere l'altre." No. Això és un registre (log). Una pàgina de botiga no mostra el codi font del joc: mostra les poques coses que necessites per decidir. Un informe selecciona: una frase per nombre, i cada nombre ha de guanyar-se el lloc. Més nombres no fan un informe millor. Normalment en fan un de pitjor.

Parts 1 a 3: què és això?

Aquestes tres gairebé no necessiten consultes. Responen "què estic mirant?".

Part 1 · Font

Digues qui ha recollit les dades, on es van publicar i quan, i qui les ha netejat. Per a la nostra taula: les dades les va recollir Liza Wood del lloc Steam Spy, i les va publicar el projecte TidyTuesday el 30 de juliol de 2019 com a video_games.csv (el fitxer de la pàgina de Recursos). A classe les vam netejar fins a games_clean.

Feble Forta
"Dades d'internet." "Dades de la botiga de Steam recollides per Liza Wood de Steam Spy, publicades per TidyTuesday el 30/07/2019 com a video_games.csv. Netejades a classe (Unitat 2) a la taula games_clean."

Un informe és reproduïble quan una altra persona, amb només el que has escrit, pot obtenir les mateixes dades i arribar als mateixos nombres.

Un fitxer es manté igual. Una API no: pot respondre diferent demà. Així que quan les teves dades vénen d'una API, com algunes dels teus propis conjunts de dades del projecte, la "font" ha de nomenar tres coses més, o ningú no podrà obtenir mai les mateixes files:

Si la font és... L'informe ha de nomenar
Un fitxer Qui l'ha publicat, on, la data de publicació i el nom del fitxer
Una API Tot això, més l'endpoint (l'adreça que has consultat), els paràmetres que has enviat i la data en què has extret les dades

Les API vénen de Fonts de dades: preguntes a una adreça web i et respon amb dades. Escriure "font: PokéAPI" és com citar un llibre com a "font: la biblioteca".

Part 2 · Mida

Una consulta et dona gairebé tot:

SELECT COUNT(*) AS n_games, MIN(release_date) AS first_release,
       MAX(release_date) AS last_release
FROM games_clean;
n_games first_release last_release
26,685 2004-01-11 2018-12-31

Afegeix el nombre de columnes (la taula en té 15) i, sobretot, digues què és una fila. Sembla massa obvi per escriure-ho. És la frase més útil de tot l'informe.

Feble Forta
"És una taula gran." "26,685 files i 15 columnes. Una fila és un joc. Els llançaments van de l'11/01/2004 al 31/12/2018."

Part 3 · Variables

No llistis les 15 columnes. Agrupa les importants i dona a cadascuna el seu tipus i la seva unitat.

Feble Forta
"Té preu, propietaris, temps de joc i puntuació." "Preu en USD, amb una marca de gratuït i una franja de preu. Propietaris mínims estimats, amb un nivell (Niche, Mid, Hit). Temps de joc en minuts. Metascore, de 0 a 100."

Sense la unitat, "temps de joc 110" podria ser minuts, hores o sessions. En aquest conjunt de dades són minuts.

Parts 4 i 5: què diu?

Aquí reutilitzes la fitxa estadística d'Estadística exploratòria. Cada frase es construeix igual.

Nombre + unitat + significat. "4.99" és el resultat d'una consulta. "El joc típic costa 4.99 USD (mediana)" és una frase.

Part 4 · Qualitat

Nomena què falta, què és estimat o dubtós, i quant. Sempre un recompte o un percentatge.

SELECT COUNT(*) AS games, COUNT(metascore) AS with_score,
       ROUND(100.0 * COUNT(metascore) / COUNT(*), 1) AS pct_with_score
FROM games_clean;
games with_score pct_with_score
26,685 2,849 10.7
Feble Forta
"Falten algunes puntuacions." "Hi ha Metascore només per a 2,849 jocs (10.7%). Es va deixar buit a propòsit: mira has_metascore."

Fixa't en la segona frase de la versió forta. A Imputació vas decidir no omplir el Metascore. L'informe és el lloc on expliques al lector les teves decisions: què has omplert, amb què, i què t'has negat a omplir.

Part 5 · Xifres clau

Centre, dispersió i una distribució. Per a la distribució, el patró de percentatge sobre el total de Variables sintètiques fa la feina:

SELECT price_band, COUNT(*) AS n,
       ROUND(100.0 * COUNT(*) / SUM(COUNT(*)) OVER (), 1) AS pct
FROM games_clean GROUP BY price_band ORDER BY n DESC;
price_band n pct
Under 5 11,613 43.5
5 to 15 9,046 33.9
Free 3,094 11.6
15 to 30 2,367 8.9
30 or more 565 2.1
Feble Forta
"El preu mitjà és 7.91." "El preu típic és 4.99 USD (mediana). La mitjana és 7.91 USD perquè uns quants productes costen fins a 595.99 USD. El 43.5% dels jocs costa menys de 5 USD i l'11.6% són gratuïts."

Compte: digues quin centre, i per què

price és asimètrica: uns quants productes molt cars estiren la mitjana cap amunt i deixen la mediana on era. Si només escrius "el preu mitjà", el lector s'imaginarà un joc típic a 7.91 USD, i la majoria de jocs costen menys. Escriu la mediana, o totes dues, i una clàusula que expliqui la diferència. Aquesta clàusula val més que un tercer decimal.

Part 6: què no et poden dir les dades

Aquesta és la part que els principiants se salten, i la que fa que un informe sigui de fiar.

Els límits d'un conjunt de dades són les preguntes que no pot respondre i les conclusions que no sustenta.

Pregunta't: quina conclusió errònia en trauria un periodista amb pressa? Aleshores escriu l'avís. Un bon límit sovint comença amb "Aquestes dades no poden dir..." o "Compte: ...".

Conclusió temptadora Per què les dades no la sustenten El límit, escrit
"PUBG va vendre 50 milions de còpies." owners_min és l'extrem inferior d'un interval estimat, no una xifra de vendes "Owners és l'extrem inferior d'una estimació, no vendes."
"Steam és més popular cada any." La taula compta llançaments, no jugadors "Aquestes dades no poden dir quanta gent juga: compten jocs llançats."

Tres columnes més amaguen un límit cadascuna: metascore, price i release_date. Pensa quins jocs reben una puntuació de les ressenyes, quin dia es va llegir el preu i quina és l'última data de la taula. Trobar aquests límits és la teva feina a la pràctica de sota.

Compte: els límits no fan que el teu informe sembli feble

El fan de fiar. Una pàgina de botiga sense requisits del sistema acaba amb devolucions. Un informe sense límits acaba amb gràfics que afirmen coses que les dades mai no van dir, amb el teu nom al damunt.

Prova-ho: escriu l'informe

Escriu l'informe descriptiu de games_clean: sis parts amb encapçalament, 250 paraules com a màxim, de manera que un company d'un altre grup pugui usar la taula sense preguntar-te res.

Pas 1 — Parts 1 a 3. La font i les variables surten de les teves notes d'aquesta unitat. La mida necessita la consulta de dalt.

Pas 2 — Parts 4 i 5. Reutilitza la teva fitxa estadística. Mínim: dos problemes de qualitat, cadascun amb un recompte o un percentatge; el centre i la dispersió de price; i una distribució (price_band o owners_tier).

Pas 3 — Part 6. Cap consulta. Almenys dos límits.

Pas 4 — Adjunta el SQL. Enganxa les consultes que hi ha darrere de cada xifra sota l'informe. No compten per a les 250 paraules. Són el que el fa reproduïble.

Pas 5 — Intercanvia. Dona el teu informe a un company i agafa el seu. Marca aquesta llista de comprovació. La regla: cada "No" ha d'assenyalar la línia a què es refereix. Sense notes i sense adjectius, només sí, no i on.

# Comprovació Sí / No
1 Les sis parts hi són, en ordre, cadascuna amb el seu encapçalament
2 La font diu qui ha recollit les dades, d'on, i quins anys cobreix. Per a una API: endpoint, paràmetres i data d'extracció
3 La mida dona files i columnes, i diu què és una fila
4 Cada xifra té una unitat, i la seva consulta és adjunta
5 Per a price, el centre és la mediana (o totes dues), i el text diu per què
6 La qualitat nomena almenys dos problemes, cadascun amb un recompte o un percentatge
7 Els límits tenen almenys dues coses que les dades no poden dir
8 Cap afirmació va més enllà de les dades. 250 paraules o menys

Després corregeix un "No" del teu propi informe. Llegir un informe que no has escrit tu és la manera més ràpida de veure què falta en el teu.

Deixa de consultar, comença a escriure

La manera habitual de quedar-se sense temps és continuar executant consultes perquè semblen progrés. Ja tens els nombres. La feina d'avui són les frases.

Idees clau

  • Un informe descriptiu és la pàgina de botiga d'un conjunt de dades: llegeix-lo abans d'usar les dades.
  • Té sis parts: font, mida, variables, qualitat, xifres clau, límits. Sempre en aquest ordre, cadascuna amb el seu encapçalament.
  • Cada xifra és nombre + unitat + significat, i la consulta que l'ha produïda s'hi adjunta.
  • La font ha de fer l'informe reproduïble. Per a una API això vol dir endpoint, paràmetres i data d'extracció.
  • Per a una columna asimètrica com price, escriu la mediana (o totes dues) i digues per què.
  • Els límits diuen què no poden dir les dades. Fan l'informe de fiar, no feble.
  • Un informe selecciona. Tots els resultats de les teves consultes enganxats són un registre, no un informe.

Comprovació ràpida

1. Quina llista té les sis parts d'un informe descriptiu, en ordre?
  • Títol, consultes, gràfics, resultats, opinió, signatura
  • Font, mida, variables, qualitat, xifres clau, límits
  • Mida, font, límits, variables, xifres clau, qualitat
  • Introducció, mètode, mitjana, mediana, gràfics, conclusió

Primer què és (font, mida, variables), després què diu (qualitat, xifres clau), després on s'atura (límits). L'ordre és fix perquè el lector sàpiga sempre on mirar, com les seccions d'una pàgina de botiga.

2. Quina frase pertany a un bon informe?
  • "El preu mitjà és 7.91."
  • "La majoria de jocs són força barats."
  • "El preu típic és 4.99 USD (mediana); la mitjana és 7.91 USD perquè uns quants productes costen fins a 595.99 USD."
  • "La columna de preu té molts valors diferents."

Té un nombre, una unitat i un significat, i diu quin centre s'usa i per què els dos discrepen. "7.91" sol no té unitat i amaga l'asimetria; "força barats" no té cap nombre.

3. L'informe A diu: els jocs són cada cop més populars. Per què aquesta afirmació va més enllà de les dades?
  • Perquè la taula només té jocs d'un any
  • Perquè la taula compta jocs llançats, no jugadors
  • Perquè la popularitat no es pot mesurar amb nombres
  • Perquè a l'afirmació li falta una unitat

La taula mostra 53 llançaments el 2004 i 8,845 el 2018: més jocs llançats. Res no hi compta quanta gent juga. Un informe s'ha d'aturar on s'aturen les dades.

4. Les dades del teu projecte vénen d'una API pública. Què ha d'incloure la part de Font, a més de qui la publica?
  • Només el nom de l'API
  • El llenguatge de programació en què està escrita l'API
  • L'endpoint, els paràmetres que has enviat i la data en què has extret les dades
  • Una captura de pantalla de la pàgina d'inici de l'API

Una API és una font viva: pot respondre diferent demà. Sense l'endpoint, els paràmetres i la data d'extracció, ningú no pot obtenir les mateixes files un altre cop, i l'informe no és reproduïble.

5. Quina frase és un límit de games_clean?
  • "La taula té 26,685 files i 15 columnes."
  • "El 43.5% dels jocs costa menys de 5 USD."
  • "Owners és l'extrem inferior d'una estimació, no vendes."
  • "Una fila és un joc."

Un límit diu què no et poden dir les dades. Les altres són mida i xifres clau: certes i útils, però descriuen què hi ha, no on s'atura.

6. Un company diu: més nombres fan un informe millor. Quina és la millor resposta?
  • Cert: un informe ha d'incloure tots els resultats de les consultes
  • Cert, sempre que cada nombre tingui dos decimals
  • Fals: un informe selecciona, i cada nombre s'ha de guanyar el lloc
  • Fals: un bon informe no conté nombres, només paraules

Tots els resultats enganxats són un registre. Una pàgina de botiga mostra les poques coses que necessites per decidir, no el codi font. Per això l'informe té un topall de 250 paraules: el límit t'obliga a triar.

7. Estàs revisant un informe sobre una taula de lloguers de pisos. Diu: Dades d'una web d'habitatge. 4,000 files. Lloguer mitjà 1,190. Tria els dos problemes que detectaria la llista de comprovació.
  • La xifra no té unitat, i el text no diu quin centre és ni si els lloguers són asimètrics
  • La font no diu qui ha recollit les dades, quan, ni quin període cobreixen
  • L'informe és massa curt: hauria de tenir almenys 250 paraules
  • El nombre de files no ha d'aparèixer en un informe

Comprovacions 4 i 5: una xifra necessita una unitat, i en una columna amb cua (una mansió ja n'hi ha prou) el lector ha de saber si 1,190 és la mitjana o la mediana. Comprovació 2: "una web d'habitatge" no és una font. I 250 paraules és un màxim, no un mínim.

Això tanca l'etapa "preparar". La teva taula és neta, mesurada i descrita. També és una taula que mai no s'ha dibuixat. Hora de construir el HUD: Unitat 3 · Visualització.