From 84c1287371a83afd2a8630d361cacecc7d8ebf26 Mon Sep 17 00:00:00 2001 From: hswerdfe Date: Mon, 1 Mar 2021 14:58:23 -0500 Subject: [PATCH] includes the label in english and french for the columns --- metadata_en.md | 298 +++++++++++++++--------------- metadata_fr.md | 298 +++++++++++++++--------------- src/generate_db_generations_sql.R | 18 +- 3 files changed, 310 insertions(+), 304 deletions(-) diff --git a/metadata_en.md b/metadata_en.md index 3f739188..00105ff6 100644 --- a/metadata_en.md +++ b/metadata_en.md @@ -44,22 +44,22 @@ Comment on the ERD in [Lucidcharts](https://lucid.app/lucidchart/invitations/acc The sample is a representative volume of wastewater taken from a Site which is then analysed by a lab. -- **sampleID**: (Primary Key) [string] Unique identifier for sample. Suggestion:siteID-date-index. +- **sampleID**:(Sample id): (Primary Key) [string] Unique identifier for sample. Suggestion:siteID-date-index. -- **siteID**: (Foreign key) [string] Links with the Site table to describe the location of sampling. +- **siteID**:(Site id): (Foreign key) [string] Links with the Site table to describe the location of sampling. -- **dateTime**: [datetime] for grab samples this is the date, time and timezone the sample was taken. +- **dateTime**:(Date time): [datetime] for grab samples this is the date, time and timezone the sample was taken. -- **dateTimeStart**: [datetime] For integrated time averaged samples this is the date, time and timezone the sample was started being taken. +- **dateTimeStart**:(Date time start): [datetime] For integrated time averaged samples this is the date, time and timezone the sample was started being taken. -- **dateTimeEnd**: [datetime] For integrated time average samples this is the date, time and timezone the sample was finished being taken. +- **dateTimeEnd**:(Date time end): [datetime] For integrated time average samples this is the date, time and timezone the sample was finished being taken. -- **type**: [category] Type of sample. +- **type**:(Type): [category] Type of sample. - `rawWW`: Raw wastewater. - `swrSed`: Sediments obtained in sewer. - `pstGrit`: Raw wastewater after a treatment plant's headworks. @@ -71,10 +71,10 @@ The sample is a representative volume of wastewater taken from a Site which is t - `faeces`: Fecal matter. - `other`: Other type of site. Add description to typeOther. -- **typeOther**: [string] Description for other type of sample not listed in +- **typeOther**:(Type other): [string] Description for other type of sample not listed in -- **collection**: [category] Method used to collect the sample. +- **collection**:(Collection): [category] Method used to collect the sample. - `cpTP24h`: A time proportional 24-hour composite sample generally collected by an autosampler. - `cpFP24h`: A flow proportional 24-hour composite sample generally collected by an autosampler. - `grb`: A single large representative grab sample. @@ -84,78 +84,78 @@ The sample is a representative volume of wastewater taken from a Site which is t - `mooreSw`: Moore swab passive sample. - `other`: Other type of collection method. Add description to collectionOther. -- **collectionOther**: [string] Description for other type of method not listed in collection. +- **collectionOther**:(Collection other): [string] Description for other type of method not listed in collection. -- **preTreatment**: [boolean] Was the sample chemically treated in anyway with the addition of stabilizers or other +- **preTreatment**:(Pre treatment): [boolean] Was the sample chemically treated in anyway with the addition of stabilizers or other -- **preTreatmentDescription**: [string] If preTreatment then describe the treatment that was performed. +- **preTreatmentDescription**:(Pre treatment description): [string] If preTreatment then describe the treatment that was performed. -- **pooled**: [boolean] Is this a pooled sample, and therefore composed of multiple child samples obtained at different sites +- **pooled**:(Pooled): [boolean] Is this a pooled sample, and therefore composed of multiple child samples obtained at different sites -- **children**: [string] If this is a sample with many smaller samples either because of pooling or sub-sampling this indicates a comma separated list of child sampleID's. +- **children**:(Children): [string] If this is a sample with many smaller samples either because of pooling or sub-sampling this indicates a comma separated list of child sampleID's. -- **parent**: [string] If this sample has been pooled into one big sample for analysis this indicates the sampleID of the larger pooled sample. +- **parent**:(Parent): [string] If this sample has been pooled into one big sample for analysis this indicates the sampleID of the larger pooled sample. -- **sizeL**: [float] Total volume of water or sludge sampled. +- **sizeL**:(Size l): [float] Total volume of water or sludge sampled. -- **fieldSampleTempC**: [float] Temperature that the sample is stored at while it is being sampled. This field is mainly relevant for composite samples which are either kept at ambient temperature or refrigerated while being sampled. +- **fieldSampleTempC**:(Field sample temp c): [float] Temperature that the sample is stored at while it is being sampled. This field is mainly relevant for composite samples which are either kept at ambient temperature or refrigerated while being sampled. -- **shippedOnIce**: [boolean] Was the sample kept cool while being shipped to the lab +- **shippedOnIce**:(Shipped on ice): [boolean] Was the sample kept cool while being shipped to the lab -- **storageTempC**: [float] Temperature that the sample is stored at in Celsius. +- **storageTempC**:(Storage temp c): [float] Temperature that the sample is stored at in Celsius. -- **qualityFlag**: [boolean] Does the reporter suspect the sample having some quality issues +- **qualityFlag**:(Quality flag): [boolean] Does the reporter suspect the sample having some quality issues -- **notes**: [string] Any additional notes. +- **notes**:(Notes): [string] Any additional notes. ## WWMeasure Measurement result (ie. single variable) from a wastewater sample. WWMeaasure includes data that is commonly collected by staff at wastewater laboratories where measurement is performed using an assay method (see AssayMethod), but can also be performed using specific instruments (see Instruments. Measures performed at the site of the wastewater sample are reported in SiteMeasure. -- **uWwMeasureID**: (Primary Key) [string] Unique identifier a measurement within the measurement table. +- **uWwMeasureID**:(U ww measure id): (Primary Key) [string] Unique identifier a measurement within the measurement table. -- **wwMeasureID**: [string] Unique identifier for wide table only. Use when all measures are performed on a single sample at the same time and same laboratory. Suggestion: siteID_sampleID_LabID_reportDate_ID. +- **wwMeasureID**:(Ww measure id): [string] Unique identifier for wide table only. Use when all measures are performed on a single sample at the same time and same laboratory. Suggestion: siteID_sampleID_LabID_reportDate_ID. -- **sampleID**: (Foreign key) [string] Links with the identified Sample +- **sampleID**:(Sample id): (Foreign key) [string] Links with the identified Sample -- **labID**: (Foreign key) [string] Links with the identified Lab that performed the analysis. +- **labID**:(Lab id): (Foreign key) [string] Links with the identified Lab that performed the analysis. -- **assayID**: (Foreign key) [string] Links with the AssayMethod used to perform the analysis. Use instrument.ID for measures that are not viral measures. +- **assayID**:(Assay id): (Foreign key) [string] Links with the AssayMethod used to perform the analysis. Use instrument.ID for measures that are not viral measures. -- **instrumentID**: (Foreign key) [string] Links with the Instrument used to perform the analysis. Use assay.ID for viral measures. +- **instrumentID**:(Instrument id): (Foreign key) [string] Links with the Instrument used to perform the analysis. Use assay.ID for viral measures. -- **reporterID**: (Foreign key) [string] Links with the reporter that is responsible for the data. +- **reporterID**:(Reporter id): (Foreign key) [string] Links with the reporter that is responsible for the data. -- **analysisDate**: [date] date the measurement was performed in the lab. +- **analysisDate**:(Analysis date): [date] date the measurement was performed in the lab. -- **reportDate**: [date] date the data was reported. One sampleID may have updated reports based on updates to assay method or reporting standard. In this situation, use the original sampleID but updated MeasureID, reportDate and assayID (if needed). +- **reportDate**:(Report date): [date] date the data was reported. One sampleID may have updated reports based on updates to assay method or reporting standard. In this situation, use the original sampleID but updated MeasureID, reportDate and assayID (if needed). -- **fractionAnalyzed**: [category] Fraction of the sample that is analyzed. +- **fractionAnalyzed**:(Fraction analyzed): [category] Fraction of the sample that is analyzed. - `liquid`: Liquid fraction - `solid`: Solid fraction - `mixed`: Mixed/homogenized sample -- **type**: [category] The variable that is being measured on the sample, e.g. a SARS-CoV-2 gene target region (cov), a biomarker for normalisation (n) or a water quality parameter (wq). +- **type**:(Type): [category] The variable that is being measured on the sample, e.g. a SARS-CoV-2 gene target region (cov), a biomarker for normalisation (n) or a water quality parameter (wq). - `covN1`: SARS-CoV-2 nucleocapsid gene N1 - `covN2`: SARS-CoV-2 nucleocapsid gene N2 - `covN3`: SARS-like coronaviruses nucleocapsid gene N3 @@ -178,10 +178,10 @@ Measurement result (ie. single variable) from a wastewater sample. WWMeaasure in - `wqCond`: Conductivity - `other`: Other measurement category. Add description to categoryOther. -- **typeOther**: [string] Description for an other variable not listed in category. +- **typeOther**:(Type other): [string] Description for an other variable not listed in category. -- **unit**: [category] Unit of the measurement. +- **unit**:(Unit): [category] Unit of the measurement. - `gcPMMoV`: Gene or variant copies per copy of PMMoV. - `gcMl`: Gene or variant copies per milliliter. - `gcGs`: Gene or variant copies per gram solids. @@ -197,10 +197,10 @@ Measurement result (ie. single variable) from a wastewater sample. WWMeaasure in - `pps`: Percent primary sludge, for total solids. - `other`: Other measurement of viral copies or wastewater treatment plant parameter. Add description to UnitOther. -- **unitOther**: [string] Description for other measurement unit not listed in unit. +- **unitOther**:(Unit other): [string] Description for other measurement unit not listed in unit. -- **aggregation**: [category] Statistical measures used to report the sample units of Ct/Cq, unless otherwise stated. Each aggregation has a corresponding value. +- **aggregation**:(Aggregation): [category] Statistical measures used to report the sample units of Ct/Cq, unless otherwise stated. Each aggregation has a corresponding value. - `single`: This value is not an aggregate measurement in any way (ie. not a mean, median, max or any other) and can be a replicate value. - `mean`: Arithmetic mean - `meanNr`: Arithmetic mean, normalized @@ -213,58 +213,58 @@ Measurement result (ie. single variable) from a wastewater sample. WWMeaasure in - `sdNr`: Standard deviation, normalized - `other`: Other aggregation method. Add description to aggregationOther -- **aggregationOther**: [string] Description for other type of aggregation not listed in aggregation. +- **aggregationOther**:(Aggregation other): [string] Description for other type of aggregation not listed in aggregation. -- **index**: [integer] Index number in case the measurement was taken multiple times. +- **index**:(Index): [integer] Index number in case the measurement was taken multiple times. -- **value**: [float] The actual measurement value that was obtained through analysis. +- **value**:(Value): [float] The actual measurement value that was obtained through analysis. -- **qualityFlag**: [boolean] Does the reporter suspect the measurement having some quality issues +- **qualityFlag**:(Quality flag): [boolean] Does the reporter suspect the measurement having some quality issues -- **accessToPublic**: [boolean] If this is 'no', this data will not be available to the public. If missing, data will be available to the public. +- **accessToPublic**:(Access to public): [boolean] If this is 'no', this data will not be available to the public. If missing, data will be available to the public. -- **accessToAllOrg**: [boolean] If this is 'no', this data will not be available to any partner organization. If missing, data will be available to the all organizations. +- **accessToAllOrg**:(Access to all org): [boolean] If this is 'no', this data will not be available to any partner organization. If missing, data will be available to the all organizations. -- **accessToSelf**: [boolean] If this is 'no', this data will not be shown on the portal when this reporter logs in. If missing, data will be available to this reporter. +- **accessToSelf**:(Access to self): [boolean] If this is 'no', this data will not be shown on the portal when this reporter logs in. If missing, data will be available to this reporter. -- **accessToPHAC**: [boolean] If this is 'no', the data will not be available to employees of the Public Health Agency of Canada - PHAC. If missing, data will be available to employees of the Public Health Agency of Canada - PHAC. +- **accessToPHAC**:(Access to phac): [boolean] If this is 'no', the data will not be available to employees of the Public Health Agency of Canada - PHAC. If missing, data will be available to employees of the Public Health Agency of Canada - PHAC. -- **accessToLocalHA**: [boolean] If this is 'no', the, data will not be available to local health authorities. If missing, data will be available to local health authorities. +- **accessToLocalHA**:(Access to local ha): [boolean] If this is 'no', the, data will not be available to local health authorities. If missing, data will be available to local health authorities. -- **accessToProvHA**: [boolean] If this is 'no', this data will not be available to provincial health authorities. If missing, data will be available to provincial health authorities. +- **accessToProvHA**:(Access to prov ha): [boolean] If this is 'no', this data will not be available to provincial health authorities. If missing, data will be available to provincial health authorities. -- **accessToOtherProv**: [boolean] If this is 'no', this data will not be available to other data providers not listed before. If missing, data will be available to other data providers not listed before +- **accessToOtherProv**:(Access to other prov): [boolean] If this is 'no', this data will not be available to other data providers not listed before. If missing, data will be available to other data providers not listed before -- **accessToDetails**: [boolean] More details on the existing confidentiality requirements of this measurement. +- **accessToDetails**:(Access to details): [boolean] More details on the existing confidentiality requirements of this measurement. -- **notes**: [string] Any additional notes. +- **notes**:(Notes): [string] Any additional notes. ## Site The site of wastewater sampling, including several defaults that can be used to populate new samples upon creation. -- **siteID**: (Primary Key) [string] Unique identifier for the location where wastewater sample was taken. +- **siteID**:(Site id): (Primary Key) [string] Unique identifier for the location where wastewater sample was taken. -- **name**: [string] Given name to the site. Location name could be a treatment plant, campus, institution or sewer location, etc. +- **name**:(Name): [string] Given name to the site. Location name could be a treatment plant, campus, institution or sewer location, etc. -- **description**: [string] Description of wastewater site (city, building, street, etc.) to better identify the location of the sampling point. +- **description**:(Description): [string] Description of wastewater site (city, building, street, etc.) to better identify the location of the sampling point. -- **type**: [category] Type of site or institution where sample was taken. +- **type**:(Type): [category] Type of site or institution where sample was taken. - `airPln`: Airplane. - `corFcil`: Correctional facility. - `school`: School @@ -288,67 +288,67 @@ The site of wastewater sampling, including several defaults that can be used to - `ocean`: Ocean, natural water body. - `other`: Other site type. Add description to typeOther. -- **typeOther**: [string] Description of the site when the site is not listed. See siteType. +- **typeOther**:(Type other): [string] Description of the site when the site is not listed. See siteType. -- **sampleTypeDefault**: [category] Used as default when a new sample is created for this site. See type in Sample table. +- **sampleTypeDefault**:(Sample type default): [category] Used as default when a new sample is created for this site. See type in Sample table. -- **sampleTypeOtherDefault**: [string] Used as default when a new sample is created for this site. See typeOther in Sample table. +- **sampleTypeOtherDefault**:(Sample type other default): [string] Used as default when a new sample is created for this site. See typeOther in Sample table. -- **sampleCollectionDefault**: [category] Used as default when a new sample is created for this site. See collection in Sample table. +- **sampleCollectionDefault**:(Sample collection default): [category] Used as default when a new sample is created for this site. See collection in Sample table. -- **sampleCollectOtherDefault**: [string] Used as default when a new sample is created for this site. See collectionOther in Sample table. +- **sampleCollectOtherDefault**:(Sample collect other default): [string] Used as default when a new sample is created for this site. See collectionOther in Sample table. -- **sampleStorageTempCDefault**: [float] Used as default when a new sample is created for this site. See storageTempC in Sample table. +- **sampleStorageTempCDefault**:(Sample storage temp c default): [float] Used as default when a new sample is created for this site. See storageTempC in Sample table. -- **measureFractionAnalyzedDefault**: [category] Used as default when a new measurement is created for this site. See fractionAnalyzed in Measurement table. +- **measureFractionAnalyzedDefault**:(Measure fraction analyzed default): [category] Used as default when a new measurement is created for this site. See fractionAnalyzed in Measurement table. -- **geoLat**: [float] Site geographical location, latitude in decimal coordinates, ie.: (45.424721) +- **geoLat**:(Geo lat): [float] Site geographical location, latitude in decimal coordinates, ie.: (45.424721) -- **geoLong**: [float] Site geographical location, longitude in decimal coordinates, ie.: (-75.695000) +- **geoLong**:(Geo long): [float] Site geographical location, longitude in decimal coordinates, ie.: (-75.695000) -- **notes**: [string] Any additional notes. +- **notes**:(Notes): [string] Any additional notes. -- **polygonID**: (Foreign key) [string] Links with the Polygon table, this should encompass the area that typically drains into this site. +- **polygonID**:(Polygon id): (Foreign key) [string] Links with the Polygon table, this should encompass the area that typically drains into this site. -- **sewerNetworkFileLink**: [string] Link to a file that has any detailed information about the sewer network associated with the site (any format). +- **sewerNetworkFileLink**:(Sewer network file link): [string] Link to a file that has any detailed information about the sewer network associated with the site (any format). -- **sewerNetworkFileBLOB**: [blob] A file blob that has any detailed information about the sewer network associated with the site (any format). +- **sewerNetworkFileBLOB**:(Sewer network file blob): [blob] A file blob that has any detailed information about the sewer network associated with the site (any format). ## SiteMeasure Measurement result (ie. single variable) obtained by at the site of wastewater sample.SiteMeasure includes data that is commonly collected by staff at wastewater treatment facilities and field sample locations. These measures that are not performed on the wastewater sample but provide additional context necessary for the interpretation of the results. Measures performed on the wastewater sample are reported in WWMeasure. -- **uSiteMeasureID**: (Primary Key) [string] Unique identifier for each measurement for a site. +- **uSiteMeasureID**:(U site measure id): (Primary Key) [string] Unique identifier for each measurement for a site. -- **siteMeasureID**: [string] Unique identifier for wide table only. Use when all measures are performed on a single sample. +- **siteMeasureID**:(Site measure id): [string] Unique identifier for wide table only. Use when all measures are performed on a single sample. -- **siteID**: (Foreign key) [string] Links with the Site table to describe the location of measurement. +- **siteID**:(Site id): (Foreign key) [string] Links with the Site table to describe the location of measurement. -- **instrumentID**: (Foreign key) [string] Links with the Instrument table to describe instrument used for the measurement. +- **instrumentID**:(Instrument id): (Foreign key) [string] Links with the Instrument table to describe instrument used for the measurement. -- **reporterID**: (Foreign key) [string] Links with the reporter that is responsible for the data. +- **reporterID**:(Reporter id): (Foreign key) [string] Links with the reporter that is responsible for the data. -- **dateTime**: [date] The date and time the measurement was performed. +- **dateTime**:(Date time): [date] The date and time the measurement was performed. -- **type**: [category] The type of measurement that was performed. The prefix env is used for environmental variables, whereas ww indicates a measurement on wastewater. +- **type**:(Type): [category] The type of measurement that was performed. The prefix env is used for environmental variables, whereas ww indicates a measurement on wastewater. - `envTemp`: Environmental temperature. - `envRnF`: Rain fall, i.e. amount of precipitation in the form of rain. - `envSnwF`: Snow fall, i.e. amount of precipitation in the form of snow. @@ -364,13 +364,13 @@ Measurement result (ie. single variable) obtained by at the site of wastewater s - `wwpH`: pH of the wastewater. - `wwCond`: Conductivity of the wastewater. -- **typeOther**: [string] Description of the measurement in case it is not listed in type. +- **typeOther**:(Type other): [string] Description of the measurement in case it is not listed in type. -- **typeDescription**: [string] Additional information on the performed measurement. +- **typeDescription**:(Type description): [string] Additional information on the performed measurement. -- **aggregation**: [category] When reporting an aggregate measurement, this field describes the method used. +- **aggregation**:(Aggregation): [category] When reporting an aggregate measurement, this field describes the method used. - `single`: This value is not an aggregate measurement in any way (ie. not a mean, median, max or any other) and can be a replicate value. - `mean`: Arithmetic mean - `meanNr`: Arithmetic mean, normalized @@ -383,133 +383,133 @@ Measurement result (ie. single variable) obtained by at the site of wastewater s - `sdNr`: Standard deviation, normalized - `other`: Other aggregation method. Add description to aggregationOther -- **aggregationOther**: [string] Description for other type of aggregation not listed in aggregation. +- **aggregationOther**:(Aggregation other): [string] Description for other type of aggregation not listed in aggregation. -- **aggregationDesc**: [string] Information on OR reference to which measurements that were included to calculate the aggregated measurement that is being reported. +- **aggregationDesc**:(Aggregation desc): [string] Information on OR reference to which measurements that were included to calculate the aggregated measurement that is being reported. -- **value**: [float] The actual value that is being reported for this measurement. +- **value**:(Value): [float] The actual value that is being reported for this measurement. -- **unit**: [string] The engineering unit of the measurement. +- **unit**:(Unit): [string] The engineering unit of the measurement. -- **qualityFlag**: [boolean] Does the reporter suspect quality issues with the value of this measurement +- **qualityFlag**:(Quality flag): [boolean] Does the reporter suspect quality issues with the value of this measurement -- **accessToPublic**: [boolean] If this is 'no', this data will not be available to the public. If missing, data will be available to the public. +- **accessToPublic**:(Access to public): [boolean] If this is 'no', this data will not be available to the public. If missing, data will be available to the public. -- **accessToAllOrgs**: [boolean] If this is 'no', this data will not be available to any partner organization. If missing, data will be available to the all organizations. +- **accessToAllOrgs**:(Access to all orgs): [boolean] If this is 'no', this data will not be available to any partner organization. If missing, data will be available to the all organizations. -- **accessToSelf**: [boolean] If this is 'no', this data will not be shown on the portal when this reporter logs in. If missing, data will be available to this reporter. +- **accessToSelf**:(Access to self): [boolean] If this is 'no', this data will not be shown on the portal when this reporter logs in. If missing, data will be available to this reporter. -- **accessToPHAC**: [boolean] If this is 'no', the data will not be available to employees of the Public Health Agency of Canada - PHAC. If missing, data will be available to employees of the Public Health Agency of Canada - PHAC. +- **accessToPHAC**:(Access to phac): [boolean] If this is 'no', the data will not be available to employees of the Public Health Agency of Canada - PHAC. If missing, data will be available to employees of the Public Health Agency of Canada - PHAC. -- **accessToLocalHA**: [boolean] If this is 'no', data will not be available to local health authorities. If missing, data will be available to local health authorities. +- **accessToLocalHA**:(Access to local ha): [boolean] If this is 'no', data will not be available to local health authorities. If missing, data will be available to local health authorities. -- **accessToProvHA**: [boolean] If this is 'no', this data will not be available to provincial health authorities. If missing, data will be available to provincial health authorities. +- **accessToProvHA**:(Access to prov ha): [boolean] If this is 'no', this data will not be available to provincial health authorities. If missing, data will be available to provincial health authorities. -- **accessToOtherProv**: [boolean] If this is 'no', this data will not be available to other data providers not listed before. If missing, data will be available to other data providers not listed before. +- **accessToOtherProv**:(Access to other prov): [boolean] If this is 'no', this data will not be available to other data providers not listed before. If missing, data will be available to other data providers not listed before. -- **accessToDetails**: [boolean] More details on the existing confidentiality requirements of this measurement. +- **accessToDetails**:(Access to details): [boolean] More details on the existing confidentiality requirements of this measurement. -- **notes**: [string] Any additional notes. +- **notes**:(Notes): [string] Any additional notes. ## Reporter The individual or organization that is reporting and responsible for the quality of the data. -- **reporterID**: (Primary Key) [string] Unique identifier for the person or organization that is reporting the data. +- **reporterID**:(Reporter id): (Primary Key) [string] Unique identifier for the person or organization that is reporting the data. -- **siteIDDefault**: (Foreign key) [string] Used as default when a new sample is created by this reporter. See ID in Site table. +- **siteIDDefault**:(Site id default): (Foreign key) [string] Used as default when a new sample is created by this reporter. See ID in Site table. -- **labIDDefault**: (Foreign key) [string] Used as default when a new sample is created by this reporter. See ID in Lab table. +- **labIDDefault**:(Lab id default): (Foreign key) [string] Used as default when a new sample is created by this reporter. See ID in Lab table. -- **contactName**: [string] Full Name of the reporter, either an organization or individual. +- **contactName**:(Contact name): [string] Full Name of the reporter, either an organization or individual. -- **contactEmail**: [string] Contact e-mail address. +- **contactEmail**:(Contact email): [string] Contact e-mail address. -- **contactPhone**: [string] Contact phone number. +- **contactPhone**:(Contact phone): [string] Contact phone number. -- **notes**: [string] Any additional notes. +- **notes**:(Notes): [string] Any additional notes. ## Lab Laboratory that performs SARS-CoV-2 wastewater testing at one or more sites. -- **labID**: (Primary Key) [string] Unique identifier for the laboratory. +- **labID**:(Lab id): (Primary Key) [string] Unique identifier for the laboratory. -- **assayMethodIDDefault**: (Foreign key) [string] Used as default when a new measurement is created for this lab. See ID in AssayMethod table. +- **assayMethodIDDefault**:(Assay method id default): (Foreign key) [string] Used as default when a new measurement is created for this lab. See ID in AssayMethod table. -- **name**: [string] Name corresponding to lab. +- **name**:(Name): [string] Name corresponding to lab. -- **contactName**: [string] Contact person or group, for the lab. +- **contactName**:(Contact name): [string] Contact person or group, for the lab. -- **contactEmail**: [string] Contact e-mail address, for the lab. +- **contactEmail**:(Contact email): [string] Contact e-mail address, for the lab. -- **contactPhone**: [string] Contact phone number, for the lab. +- **contactPhone**:(Contact phone): [string] Contact phone number, for the lab. -- **updateDate**: [date] date information was provided or updated. +- **updateDate**:(Update date): [date] date information was provided or updated. ## AssayMethod The assay method that was used to perform testing. Create a new record if there are changes (improvements) to an existing assay method. Keep the same ID and use an updated version. A new record for a new version can include only the fields that changed, however, we recommend duplicating existing fields to allow each record to clearly describe all steps. Add a current date when recording a new version to an assay. -- **assayMethodID**: (Primary Key) [string] Unique identifier for the assay method. +- **assayMethodID**:(Assay method id): (Primary Key) [string] Unique identifier for the assay method. -- **instrumentID**: (Foreign key) [string] Links with the Instrument table to describe instruments used for the measurement. +- **instrumentID**:(Instrument id): (Foreign key) [string] Links with the Instrument table to describe instruments used for the measurement. -- **name**: [string] Name of the assay method. +- **name**:(Name): [string] Name of the assay method. -- **version**: [string] Version of the assay. Semantic versioning is recommended. +- **version**:(Version): [string] Version of the assay. Semantic versioning is recommended. -- **summary**: [string] Short description of the assay and how it is different from the other assay methods. +- **summary**:(Summary): [string] Short description of the assay and how it is different from the other assay methods. -- **referenceLink**: [string] Link to standard operating procedure. +- **referenceLink**:(Reference link): [string] Link to standard operating procedure. -- **date**: [date] date on which the assayMethod was created or updated (for version update). +- **date**:(Date): [date] date on which the assayMethod was created or updated (for version update). -- **aliasID**: [string] ID of an assay that is the same or similar. a comma separated list. +- **aliasID**:(Alias id): [string] ID of an assay that is the same or similar. a comma separated list. -- **sampleSizeL**: [float] Size of the sample that is analyzed in liters. +- **sampleSizeL**:(Sample size l): [float] Size of the sample that is analyzed in liters. -- **loq**: [float] Limit of quantification (LOQ) for this method if one exists. +- **loq**:(Loq): [float] Limit of quantification (LOQ) for this method if one exists. -- **lod**: [float] Limit of detection (LOD) for this method if one exists. +- **lod**:(Lod): [float] Limit of detection (LOD) for this method if one exists. -- **unit**: [category] Unit used by this method, and applicable to the LOD and LOQ. +- **unit**:(Unit): [category] Unit used by this method, and applicable to the LOD and LOQ. - `gcPMMoV`: Gene copies per copy of PMMoV. - `gcMl`: Gene copies per milliliter. - `gcGms`: Gene copies per gram solids. @@ -517,99 +517,99 @@ The assay method that was used to perform testing. Create a new record if there - `gcCrA`: Gene copies per copy of crAssphage. - `other`: Other measurement of viral copies. Add description to unitOther. -- **unitOther**: [string] Unit used by this method, that are applicable to the LOD and LOQ. +- **unitOther**:(Unit other): [string] Unit used by this method, that are applicable to the LOD and LOQ. -- **methodConc**: [string] Description of the method used to concentrate the sample +- **methodConc**:(Method conc): [string] Description of the method used to concentrate the sample -- **methodExtract**: [string] Description of the method used to extract the sample +- **methodExtract**:(Method extract): [string] Description of the method used to extract the sample -- **methodPcr**: [string] Description of the PCR method used +- **methodPcr**:(Method pcr): [string] Description of the PCR method used -- **qualityAssQC**: [string] Description of the quality control steps taken +- **qualityAssQC**:(Quality ass qc): [string] Description of the quality control steps taken -- **inhibition**: [string] Description of the inhibition parameters. +- **inhibition**:(Inhibition): [string] Description of the inhibition parameters. -- **surrogateRecovery**: [string] Description of the surrogate recovery for this method. +- **surrogateRecovery**:(Surrogate recovery): [string] Description of the surrogate recovery for this method. ## Instrument Instruments that are used for measures in WWMeasure and SiteMeasure. The assay method for viral measurement are described in AssayMethod. -- **instrumentID**: (Primary Key) [string] Unique identifier for the instrument. +- **instrumentID**:(Instrument id): (Primary Key) [string] Unique identifier for the instrument. -- **name**: [string] Name of the instrument used to perform the measurement. +- **name**:(Name): [string] Name of the instrument used to perform the measurement. -- **model**: [string] Model number or version of the instrument. +- **model**:(Model): [string] Model number or version of the instrument. -- **description**: [string] Description of the instrument. +- **description**:(Description): [string] Description of the instrument. -- **alias**: [string] ID of an assay that is the same or similar. A comma separated list. +- **alias**:(Alias): [string] ID of an assay that is the same or similar. A comma separated list. -- **referenceLink**: [string] Link to reference for the instrument. +- **referenceLink**:(Reference link): [string] Link to reference for the instrument. -- **type**: [category] Type of instrument used to perform the measurement. +- **type**:(Type): [category] Type of instrument used to perform the measurement. - `online`: An online sensor - `lab`: Offline laboratory analysis - `hand`: A handheld measurement analyzer. - `atline`: An atline analyzer with sampler. - `other`: An other type of measurement instrument. Add description to instrumentTypeOther. -- **typeOther**: [string] Description of the instrument in case it is not listed in instrumentType. +- **typeOther**:(Type other): [string] Description of the instrument in case it is not listed in instrumentType. ## Polygon A simple polygon that encloses an area on the surface of the earth, normally these polygons will either be of a sewer catchment area or of a health region or other reporting area. -- **polygonID**: (Primary Key) [string] Unique identifier for the polygon. +- **polygonID**:(Polygon id): (Primary Key) [string] Unique identifier for the polygon. -- **name**: [string] Descriptive name of the polygon. +- **name**:(Name): [string] Descriptive name of the polygon. -- **pop**: [integer] Approximate population size of people living inside the polygon. +- **pop**:(Pop): [integer] Approximate population size of people living inside the polygon. -- **type**: [category] Type of polygon. +- **type**:(Type): [category] Type of polygon. - `swrCat`: Sewer catchment area. - `hlthReg`: Health region served by the sewer network -- **wkt**: [string] well known text of the polygon +- **wkt**:(Wkt): [string] well known text of the polygon -- **file**: [blob] File containing the geometry of the polygon, blob format. +- **file**:(File): [blob] File containing the geometry of the polygon, blob format. -- **link**: [string] Link to an external reference that describes the geometry of the polygon. +- **link**:(Link): [string] Link to an external reference that describes the geometry of the polygon. ## CovidPublicHealthData Covid-19 patient data for a specified polygon. -- **cphdID**: (Primary Key) [string] Unique identifier for the table. +- **cphdID**:(Cphd id): (Primary Key) [string] Unique identifier for the table. -- **reporterID**: (Foreign key) [string] ID of the reporter who gave this data. +- **reporterID**:(Reporter id): (Foreign key) [string] ID of the reporter who gave this data. -- **polygonID**: (Foreign key) [string] Links with the Polygon table. +- **polygonID**:(Polygon id): (Foreign key) [string] Links with the Polygon table. -- **date**: [string] date of reporting for covid-19 measure. +- **date**:(Date): [string] date of reporting for covid-19 measure. -- **type**: [category] Type of covid-19 patient data. +- **type**:(Type): [category] Type of covid-19 patient data. - `conf`: Number of confirmed cases. This measure should be accompanied by dateType. - `active`: Number of active cases. - `test`: Number of tests performed. @@ -618,31 +618,31 @@ Covid-19 patient data for a specified polygon. - `hospCen`: Hospital census or the number of people admitted with covid-19. - `hospAdm`: Hospital admissions or patients newly admitted to hospital. -- **dateType**: [category] Type of date used for conf cases. Typically report or episode are reported. onset and test date is not usually reported within aggregate data. +- **dateType**:(Date type): [category] Type of date used for conf cases. Typically report or episode are reported. onset and test date is not usually reported within aggregate data. - `episode`: Episode date is the earliest of onset, test or reported date. - `onset`: Earliest that symptoms were reported for this case. This data is often not known and reported. In lieu, episode is used. - `report`: Date that the numbers were reported publicly. Typically, reported data and this measure is most commonly reported and used. - `test`: Date that the covid-19 test was performed. -- **value**: [float] The numeric value that is being reported. +- **value**:(Value): [float] The numeric value that is being reported. -- **notes**: [string] Any additional notes. +- **notes**:(Notes): [string] Any additional notes. ## Lookup Used for lookup values of all category based columns -- **tableName**: [string] Name of the Table +- **tableName**:(Table name): [string] Name of the Table -- **columnName**: [string] Name for the column +- **columnName**:(Column name): [string] Name for the column -- **value**: [string] Name of the value +- **value**:(Value): [string] Name of the value -- **description**: [string] Name of the description +- **description**:(Description): [string] Name of the description diff --git a/metadata_fr.md b/metadata_fr.md index 4e43bef5..68b379d0 100644 --- a/metadata_fr.md +++ b/metadata_fr.md @@ -45,22 +45,22 @@ Commentaire sur l'ERD dans [Lucidcharts](https://lucid.app/lucidchart/invitation L'échantillon est un volume d'eau usée représentatif de l'eau présente sur un site, qui est ensuite analysé en laboratoire. -- **sampleID**: (Primary Key) [string] Identifiant unique pour l'échantillon. Suggestion:siteID-date-index. +- **sampleID**:(Identifiant de l'échantillon): (Primary Key) [string] Identifiant unique pour l'échantillon. Suggestion:siteID-date-index. -- **siteID**: (Foreign key) [string] Crée un lien avec la table "Site" pour décrire le point d'échantillonage. +- **siteID**:(Identifiant du site): (Foreign key) [string] Crée un lien avec la table "Site" pour décrire le point d'échantillonage. -- **dateTime**: [datetime] Date, heure et fuseau horaire de collecte d'un échantillon ponctuel. +- **dateTime**:(Date et heure): [datetime] Date, heure et fuseau horaire de collecte d'un échantillon ponctuel. -- **dateTimeStart**: [datetime] Date, heure et fuseau horaire de début de collecte d'un échantillon composite. +- **dateTimeStart**:(Date et heure de début): [datetime] Date, heure et fuseau horaire de début de collecte d'un échantillon composite. -- **dateTimeEnd**: [datetime] Date, heure et fuseau horaire de fin de collecte d'un échantillon composite. +- **dateTimeEnd**:(Date et heure de fin): [datetime] Date, heure et fuseau horaire de fin de collecte d'un échantillon composite. -- **type**: [category] Type d'échantillon. +- **type**:(Type): [category] Type d'échantillon. - `rawWW`: Eau usée brute - `swrSed`: Sédiments provenant des égouts. - `pstGrit`: Eau usée après dégrillage et dessablage. @@ -72,10 +72,10 @@ L'échantillon est un volume d'eau usée représentatif de l'eau présente sur u - `faeces`: Matière fécale. - `other`: Autre type de site d'échantillonnage. Ajouter une description dans la colonne "typeOther" -- **typeOther**: [string] Description d'un type d'échantillon ne faisant pas partie des options disponibles. +- **typeOther**:(Type autre): [string] Description d'un type d'échantillon ne faisant pas partie des options disponibles. -- **collection**: [category] Méthode utilisée pour échantillonner. +- **collection**:(Méthode de collecte): [category] Méthode utilisée pour échantillonner. - `cpTP24h`: Un échantillon composite proportionnel au temps prélevé sur 24 heures, généralement prélevé par un auto-échantilonneur. - `cpFP24h`: Un échantillon composite proportionnel au débit prélevé sur 24 heures, généralement prélevé par un auto-échantilonneur. - `grb`: Un seul échantillon ponctuel représentatif. @@ -85,78 +85,78 @@ L'échantillon est un volume d'eau usée représentatif de l'eau présente sur u - `mooreSw`: Un échantillon passif collecté par la méthode de Moore. - `other`: Autre méthode de collecte. Ajouter une description dans la colonne "descriptionOther" -- **collectionOther**: [string] Description d'une méthode d'échantillonnage ne faisant pas partie des options disponibles. +- **collectionOther**:(Méthode de collecte autre): [string] Description d'une méthode d'échantillonnage ne faisant pas partie des options disponibles. -- **preTreatment**: [boolean] L'échantillon a-t-il été chimiquement altéré par un ajout de stabilisant ou autre? +- **preTreatment**:(Pré-traitement): [boolean] L'échantillon a-t-il été chimiquement altéré par un ajout de stabilisant ou autre? -- **preTreatmentDescription**: [string] Description du pré-traitement le cas échéant. +- **preTreatmentDescription**:(Description du pré-traitment): [string] Description du pré-traitement le cas échéant. -- **pooled**: [boolean] S'il s'agit d'un échantillon combiné, c'est-à-dire s'il est composé de plusieurs échantillons "enfants"? +- **pooled**:(Échantillon combiné): [boolean] S'il s'agit d'un échantillon combiné, c'est-à-dire s'il est composé de plusieurs échantillons "enfants"? -- **children**: [string] Si l'échantillon est liée à des sous-échantillons (soit parce qu'il s'agit d'un échantillon combiné ou parce que des sous-échantillons ont été prélevés dans cet échantillon), insérer les identifiant des échantillons enfants dans une liste séparée par des virgules. +- **children**:(Enfants): [string] Si l'échantillon est liée à des sous-échantillons (soit parce qu'il s'agit d'un échantillon combiné ou parce que des sous-échantillons ont été prélevés dans cet échantillon), insérer les identifiant des échantillons enfants dans une liste séparée par des virgules. -- **parent**: [string] Si l'échantillon a été combiné à un plus grand échantillon, indiquer l'identifiant du plus grand échantillon. +- **parent**:(Parent): [string] Si l'échantillon a été combiné à un plus grand échantillon, indiquer l'identifiant du plus grand échantillon. -- **sizeL**: [float] Volume total d'eau ou de boue prélevée. +- **sizeL**:(Volume l): [float] Volume total d'eau ou de boue prélevée. -- **fieldSampleTempC**: [float] Temprature à laquelle l'échantillon était stocké pendant l'échantillonnage. Ce champ est principalement pertinent pour les échantillons composites, qui peuvent être stockées à température ambiante ou réfrigérés durant l'échantillonnage. +- **fieldSampleTempC**:(Température de l'échantillon de terrain c): [float] Temprature à laquelle l'échantillon était stocké pendant l'échantillonnage. Ce champ est principalement pertinent pour les échantillons composites, qui peuvent être stockées à température ambiante ou réfrigérés durant l'échantillonnage. -- **shippedOnIce**: [boolean] L'échantillon a-t-il été gardé au froid lors du transport vers le laboratoire? +- **shippedOnIce**:(Expédié sur glace): [boolean] L'échantillon a-t-il été gardé au froid lors du transport vers le laboratoire? -- **storageTempC**: [float] Température de stockage de l'échantillon en degrés Celsius +- **storageTempC**:(Température de stockage c): [float] Température de stockage de l'échantillon en degrés Celsius -- **qualityFlag**: [boolean] Le reporteur a-t-il des doutes sur la qualité de l'échantillon? +- **qualityFlag**:(Indicateur de mauvaise qualité): [boolean] Le reporteur a-t-il des doutes sur la qualité de l'échantillon? -- **notes**: [string] Ajouter toutes notes additionnelles. +- **notes**:(Notes): [string] Ajouter toutes notes additionnelles. ## WWMeasure Résultat de mesure (une seule variable à la fois) pour un échantillon d'eau usée. Cette table inclut des données typiquement collectées par les techniciens de laboratoires d'analyse des eaux usées. Ces mesures sont réalisées à l'aide d'une méthode d'analyse (voir la table "AssayMethod") ou encore à l'aide d'un instrument spécifique (voir la table "Instrument'). Les mesures réalise in-situ au site d'échantilonnage sont reportées dans la table "SiteMeasure". -- **uWwMeasureID**: (Primary Key) [string] Identifiant unique pour la mesure pour la table "WWMeasurement" +- **uWwMeasureID**:(id u mesure eaux usées): (Primary Key) [string] Identifiant unique pour la mesure pour la table "WWMeasurement" -- **wwMeasureID**: [string] Identifiat unique utilisé dans la table horizontale seulement. Utiliser quand toutes les mesures effectuées sur un échantillon sont réalisées en même temps dans le même laboratoire. Suggestion: siteID_sampleID_LabID_reportDate_ID. +- **wwMeasureID**:(id mesure eaux usées): [string] Identifiat unique utilisé dans la table horizontale seulement. Utiliser quand toutes les mesures effectuées sur un échantillon sont réalisées en même temps dans le même laboratoire. Suggestion: siteID_sampleID_LabID_reportDate_ID. -- **sampleID**: (Foreign key) [string] Crée un lien avec la table "Sample" pour décrire l'échantillon mesuré. +- **sampleID**:(Identifiant de l'échantillon): (Foreign key) [string] Crée un lien avec la table "Sample" pour décrire l'échantillon mesuré. -- **labID**: (Foreign key) [string] Crée un lien avec la table "Lab" pour décrire le laboratoire effectuant la mesure. +- **labID**:(Identifiant du laboratoire): (Foreign key) [string] Crée un lien avec la table "Lab" pour décrire le laboratoire effectuant la mesure. -- **assayID**: (Foreign key) [string] Crée un lien avec la table "AssayMethod" pour décrire la méthode employée pour effectuer la mesure. Utiliser l'identifiant de l'instrument pour des mesures non virales. +- **assayID**:(Identifiant de la méthode d'analyse): (Foreign key) [string] Crée un lien avec la table "AssayMethod" pour décrire la méthode employée pour effectuer la mesure. Utiliser l'identifiant de l'instrument pour des mesures non virales. -- **instrumentID**: (Foreign key) [string] Crée un lien avec la table "Instrument" l'appareil employé pour effectuer la mesure. Utiliser l'identifiant de la méthode d,analyse pour les mesures virales. +- **instrumentID**:(Identifiant de l'instrument): (Foreign key) [string] Crée un lien avec la table "Instrument" l'appareil employé pour effectuer la mesure. Utiliser l'identifiant de la méthode d,analyse pour les mesures virales. -- **reporterID**: (Foreign key) [string] Crée un lien avec les informations propres au reporteur associé à la mesure. +- **reporterID**:(Identifiant du reporteur): (Foreign key) [string] Crée un lien avec les informations propres au reporteur associé à la mesure. -- **analysisDate**: [date] Date à laquelle la mesure a été réalisée en laboratoire. +- **analysisDate**:(Date de l'analyse): [date] Date à laquelle la mesure a été réalisée en laboratoire. -- **reportDate**: [date] Date a laquelle la donnée a été reportée. Un échantillon pourrait avoir des mesures pour lesquelles la méthode d'analyse ou la méthode de reportage des données aurait changée. Dans ce cas, utiliser le même sampleID, mais créer une nouvelle entrée dans la table "WWMeasure avec un "MeasureID" différent, et la date de reportage de la donnée et l'identifiant de la méthode d'analyse appropriés. +- **reportDate**:(Date de reportage de la donnée): [date] Date a laquelle la donnée a été reportée. Un échantillon pourrait avoir des mesures pour lesquelles la méthode d'analyse ou la méthode de reportage des données aurait changée. Dans ce cas, utiliser le même sampleID, mais créer une nouvelle entrée dans la table "WWMeasure avec un "MeasureID" différent, et la date de reportage de la donnée et l'identifiant de la méthode d'analyse appropriés. -- **fractionAnalyzed**: [category] Fraction de l'échantillon employée pour la mesure. +- **fractionAnalyzed**:(Fraction analysée): [category] Fraction de l'échantillon employée pour la mesure. - `liquid`: Fraction liquide. - `solid`: Fraction solide. - `mixed`: Échantillon homogénéisé/mélangé. -- **type**: [category] Le paramètre mesuré avec cette analyse. Exemples: Une région de gène cible (cov), un biomarqueur (n) ou un indicateur de la qualité de l'eau (wq) +- **type**:(Type): [category] Le paramètre mesuré avec cette analyse. Exemples: Une région de gène cible (cov), un biomarqueur (n) ou un indicateur de la qualité de l'eau (wq) - `covN1`: Gène nucleocapside N1 du SARS-CoV-2 - `covN2`: Gène nucleocapside N2 du SARS-CoV-2 - `covN3`: Gène nucleocapside N3 des virus similaires au SARS @@ -179,10 +179,10 @@ Résultat de mesure (une seule variable à la fois) pour un échantillon d'eau u - `wqCond`: Conductivité - `other`: Autre catégorie de mesure. Ajouter une description de la catégorie dans la colonne "categoryOther". -- **typeOther**: [string] Description d'un paramètre mesuré ne faisant pas partie des options disponibles. +- **typeOther**:(Type autre): [string] Description d'un paramètre mesuré ne faisant pas partie des options disponibles. -- **unit**: [category] Unité de mesure. +- **unit**:(Unité): [category] Unité de mesure. - `gcPMMoV`: Copies de gène ou de variant par copie de PMMoV - `gcMl`: Copies de gène ou de variant par millilitre. - `gcGs`: Copies de gène ou de variant par gramme de solides. @@ -198,10 +198,10 @@ Résultat de mesure (une seule variable à la fois) pour un échantillon d'eau u - `pps`: Pourcentage de boues primaire (pour solides totaux) - `other`: Autre mesure de copies virales ou de qualité des eaux usées. Ajouter une description dans "unitOther" -- **unitOther**: [string] Description d'une unité de mesure ne faisant pas partie des options disponibles. +- **unitOther**:(Unité autre): [string] Description d'une unité de mesure ne faisant pas partie des options disponibles. -- **aggregation**: [category] Indicateur statistique utilisée pour rapporter la mesure effectuée. Chaque agrégation doit être reportée comme une mesure différente (avec un identifiant différent) +- **aggregation**:(Agrégation): [category] Indicateur statistique utilisée pour rapporter la mesure effectuée. Chaque agrégation doit être reportée comme une mesure différente (avec un identifiant différent) - `single`: La valeur n'a subi aucune agrégation (donc, la valeur n'est pas une moyenne, un maximum, etc.). La valeur peut être un réplica. - `mean`: Moyenne arithmétique. - `meanNr`: Moyenne arithmétique normalisée. @@ -214,58 +214,58 @@ Résultat de mesure (une seule variable à la fois) pour un échantillon d'eau u - `sdNr`: L'écart type normalisé. - `other`: Autre méthode d'agrégation. Ajouter une description dans "aggregationOther". -- **aggregationOther**: [string] Description d'une agrégation ne faisant pas partie des options disponibles. +- **aggregationOther**:(Agrégation autre): [string] Description d'une agrégation ne faisant pas partie des options disponibles. -- **index**: [integer] Index de la mesure dans le cas où la même mesure a été prise en replicata. +- **index**:(Index): [integer] Index de la mesure dans le cas où la même mesure a été prise en replicata. -- **value**: [float] La valeur numérique de la mesure effectuée. +- **value**:(Valeur): [float] La valeur numérique de la mesure effectuée. -- **qualityFlag**: [boolean] Le reporteur de la mesure suspecte-t-il que la mesure est de mauvaise qualité? +- **qualityFlag**:(Indicateur de mauvaise qualité): [boolean] Le reporteur de la mesure suspecte-t-il que la mesure est de mauvaise qualité? -- **accessToPublic**: [boolean] Si "Non", la donnée ne sera pas accessible par le public. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToPublic**:(Accès au public): [boolean] Si "Non", la donnée ne sera pas accessible par le public. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToAllOrg**: [boolean] Si "Non", la donnée ne sera pas accessible par toute organisation partenaire. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToAllOrg**:(Accès à toutes les organisations): [boolean] Si "Non", la donnée ne sera pas accessible par toute organisation partenaire. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToSelf**: [boolean] Si "Non", la donnée ne sera pas accessible par le reporteur lui-même. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToSelf**:(Accès au reporteur lui-même): [boolean] Si "Non", la donnée ne sera pas accessible par le reporteur lui-même. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToPHAC**: [boolean] Si "Non", la donnée ne sera pas accessible par les employés de l'Agence de Santé Publique du Canada. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToPHAC**:(Accès à l'ASPC): [boolean] Si "Non", la donnée ne sera pas accessible par les employés de l'Agence de Santé Publique du Canada. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToLocalHA**: [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique locales. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToLocalHA**:(Accès à l'autorité de santé publique locale): [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique locales. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToProvHA**: [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée sera accessible à l'autorité de santé publique de la province où l'échantillonnage a été réalisée. +- **accessToProvHA**:(Accès à l'autorité de santé publique provinciale): [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée sera accessible à l'autorité de santé publique de la province où l'échantillonnage a été réalisée. -- **accessToOtherProv**: [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToOtherProv**:(Accès aux autres prov): [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToDetails**: [boolean] Indique si des informations supplémentaires sur la confidentialité de la mesure sont disponibles. +- **accessToDetails**:(Accès aux détails): [boolean] Indique si des informations supplémentaires sur la confidentialité de la mesure sont disponibles. -- **notes**: [string] Ajouter toutes notes additionnelles. +- **notes**:(Notes): [string] Ajouter toutes notes additionnelles. ## Site Le site de collecte des échantilons d'eau usée. Cette table inclus plusieurs paramètres par défaut facilitant la création de nouvaux échantillons dans la table "Sample" -- **siteID**: (Primary Key) [string] Identifiant unique pour l'échantillon. Suggestion:siteID-date-index. +- **siteID**:(Identifiant du site): (Primary Key) [string] Identifiant unique pour l'échantillon. Suggestion:siteID-date-index. -- **name**: [string] Nom du site d'échantillonnage. Peut être le nom d'une station de traitement, d'une station de pompage, d'un campus, d'un regard d'égouts, etc. +- **name**:(Nom): [string] Nom du site d'échantillonnage. Peut être le nom d'une station de traitement, d'une station de pompage, d'un campus, d'un regard d'égouts, etc. -- **description**: [string] Description du site d'échantillonnage (ville, bâtiment, rue, etc.) pour mieux identifier le site d'échantillonnage. +- **description**:(Description): [string] Description du site d'échantillonnage (ville, bâtiment, rue, etc.) pour mieux identifier le site d'échantillonnage. -- **type**: [category] Type de site ou d'institution du site d'échantillonnage. +- **type**:(Type): [category] Type de site ou d'institution du site d'échantillonnage. - `airPln`: Avion. - `corFcil`: Prison. - `school`: École. @@ -289,67 +289,67 @@ Le site de collecte des échantilons d'eau usée. Cette table inclus plusieurs p - `ocean`: Océan, étendue d'eau naturelle. - `other`: Autre type de site. Ajouter une description dans "typeOther". -- **typeOther**: [string] Description du site d'échantillonnage dans le cas où une description adéquate n'est pas disponible. +- **typeOther**:(Type autre): [string] Description du site d'échantillonnage dans le cas où une description adéquate n'est pas disponible. -- **sampleTypeDefault**: [category] Type d'échantilon utilisé par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "type" dans la table "Sample" +- **sampleTypeDefault**:(Type d'échantillon par défaut): [category] Type d'échantilon utilisé par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "type" dans la table "Sample" -- **sampleTypeOtherDefault**: [string] Type d'échantilon utilisé par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "typeOther" dans la table "Sample" +- **sampleTypeOtherDefault**:(Type d'échantillon autre défaut): [string] Type d'échantilon utilisé par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "typeOther" dans la table "Sample" -- **sampleCollectionDefault**: [category] Méthode d'échantillonnage par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "collection" dans la table "Sample" +- **sampleCollectionDefault**:(Prélévement d'échantillons par défaut): [category] Méthode d'échantillonnage par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "collection" dans la table "Sample" -- **sampleCollectOtherDefault**: [string] Méthode d'échantillonnage par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "collectionOther" dans la table "Sample" +- **sampleCollectOtherDefault**:(Prélévement d'un autre échantillon par défaut): [string] Méthode d'échantillonnage par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "collectionOther" dans la table "Sample" -- **sampleStorageTempCDefault**: [float] Tempéraure de stockage par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "storageTempC" dans la table "Sample" +- **sampleStorageTempCDefault**:(Température de stockage de l'échantillon c par défaut): [float] Tempéraure de stockage par défaut quand un nouvel échantillon est créé pour ce site. Se référer à la colonne "storageTempC" dans la table "Sample" -- **measureFractionAnalyzedDefault**: [category] Fraction par défaut quand une nouvelle mesure est créée pour cet échantillon. Se référer à la colonne "fracgtionAnalyzed" dans la table "WWMeasure" +- **measureFractionAnalyzedDefault**:(Fraction de mesure analysée par défaut): [category] Fraction par défaut quand une nouvelle mesure est créée pour cet échantillon. Se référer à la colonne "fracgtionAnalyzed" dans la table "WWMeasure" -- **geoLat**: [float] Position géographique du site d'échantillonnage. Latitude exprimée en coordonnées décimales (ex. 45.424721) +- **geoLat**:(Géo lat): [float] Position géographique du site d'échantillonnage. Latitude exprimée en coordonnées décimales (ex. 45.424721) -- **geoLong**: [float] Position géographique du site d'échantillonnage. Longitude exprimée en coordonnées décimales (ex. -75.695000) +- **geoLong**:(Géo long): [float] Position géographique du site d'échantillonnage. Longitude exprimée en coordonnées décimales (ex. -75.695000) -- **notes**: [string] Ajouter toutes notes additionnelles. +- **notes**:(Notes): [string] Ajouter toutes notes additionnelles. -- **polygonID**: (Foreign key) [string] Crée un lien vers la table "Polygon". Le polygon lié devrait englober la région qui se draine dans le site d'échantillonnage. +- **polygonID**:(Identifiant du polygone): (Foreign key) [string] Crée un lien vers la table "Polygon". Le polygon lié devrait englober la région qui se draine dans le site d'échantillonnage. -- **sewerNetworkFileLink**: [string] Lien vers un fichier contenant toute information additionnelle au sujet du réseau d'égouts associé à ce site d'échantillonnage (tous les formats sont acceptés). +- **sewerNetworkFileLink**:(Lien vers le fichier du réseau d'égouts): [string] Lien vers un fichier contenant toute information additionnelle au sujet du réseau d'égouts associé à ce site d'échantillonnage (tous les formats sont acceptés). -- **sewerNetworkFileBLOB**: [blob] Un fichier contenant toute information additionnelle au sujet du réseau d'égouts associé à ce site d'échantillonnage (tous les formats sont acceptés). +- **sewerNetworkFileBLOB**:(Fichier blob du réseau d'égouts): [blob] Un fichier contenant toute information additionnelle au sujet du réseau d'égouts associé à ce site d'échantillonnage (tous les formats sont acceptés). ## SiteMeasure Résultat de mesure (une seule variable à la fois) pour un site d'échantillonnage. Cette table inclut des données typiquement collectées dans des stations de traitement des eaux usées et des sites d'échantillonnage de terrain. Ces mesures ne sont pas réalisées sur un échantillon, mais elles ajoutent des informations pertinentes pour l'analyse des résultats provenant des échantillons. Les mesures effectuées sur les échantilons eux-mêmes sont dans la table "WWMeasure". -- **uSiteMeasureID**: (Primary Key) [string] Identifiant unique pour le site d'échantillonnage. +- **uSiteMeasureID**:(Identifiant unique de la mesure sur site): (Primary Key) [string] Identifiant unique pour le site d'échantillonnage. -- **siteMeasureID**: [string] Identifiat unique utilisé dans la table horizontale seulement. Utiliser quand toutes les mesures effectuées sur le même échantillon. +- **siteMeasureID**:(Identifiant de la mesure sur site): [string] Identifiat unique utilisé dans la table horizontale seulement. Utiliser quand toutes les mesures effectuées sur le même échantillon. -- **siteID**: (Foreign key) [string] Crée un lien vers la table "Site" pour décrire le site d'échantillonnage. +- **siteID**:(Identifiant du site): (Foreign key) [string] Crée un lien vers la table "Site" pour décrire le site d'échantillonnage. -- **instrumentID**: (Foreign key) [string] Crée un lien vers la table "Instrument" pour décrire l'appareil utilisé pour effectuer la mesure. +- **instrumentID**:(Identifiant de l'instrument): (Foreign key) [string] Crée un lien vers la table "Instrument" pour décrire l'appareil utilisé pour effectuer la mesure. -- **reporterID**: (Foreign key) [string] Crée un lien avec les informations propres au reporteur associé à la mesure. +- **reporterID**:(Identifiant du reporteur): (Foreign key) [string] Crée un lien avec les informations propres au reporteur associé à la mesure. -- **dateTime**: [date] Date à laquelle la mesure a été réalisée. +- **dateTime**:(Date et heure): [date] Date à laquelle la mesure a été réalisée. -- **type**: [category] Type de mesure réalisée. Le préfixe "env" est utilisé pour une variable envioronnementale, alors que "ww" indique une mesure réalisée sur les eaux usées. +- **type**:(Type): [category] Type de mesure réalisée. Le préfixe "env" est utilisé pour une variable envioronnementale, alors que "ww" indique une mesure réalisée sur les eaux usées. - `envTemp`: Température ambiante. - `envRnF`: Pluie (toute précipitation sous forme liquide). - `envSnwF`: Neige (toute précipitations sous forme solide). @@ -365,13 +365,13 @@ Résultat de mesure (une seule variable à la fois) pour un site d'échantillonn - `wwpH`: pH - `wwCond`: Conductivité -- **typeOther**: [string] Description d'un paramètre mesuré ne faisant pas partie des options disponibles. +- **typeOther**:(Type autre): [string] Description d'un paramètre mesuré ne faisant pas partie des options disponibles. -- **typeDescription**: [string] Ajouter toutes notes additionnelles en lien avec la mesure effectuée. +- **typeDescription**:(Description du type): [string] Ajouter toutes notes additionnelles en lien avec la mesure effectuée. -- **aggregation**: [category] Méthode d'agrégation utiliseée pour rapporter la mesure. +- **aggregation**:(Agrégation): [category] Méthode d'agrégation utiliseée pour rapporter la mesure. - `single`: La valeur n'a subi aucune agrégation (donc, la valeur n'est pas une moyenne, un maximum, etc.). La valeur peut être un réplica. - `mean`: Moyenne arithmétique. - `meanNr`: Moyenne arithmétique normalisée. @@ -384,133 +384,133 @@ Résultat de mesure (une seule variable à la fois) pour un site d'échantillonn - `sdNr`: L'écart type normalisé. - `other`: Autre méthode d'agrégation. Ajouter une description dans "aggregationOther". -- **aggregationOther**: [string] Description d'une agrégation ne faisant pas partie des options disponibles. +- **aggregationOther**:(Agrégation autre): [string] Description d'une agrégation ne faisant pas partie des options disponibles. -- **aggregationDesc**: [string] Informations (ou référence) liée(s) à la méthode d'agrégation utilisée pour rapporter la mesure. +- **aggregationDesc**:(Agrégation desc): [string] Informations (ou référence) liée(s) à la méthode d'agrégation utilisée pour rapporter la mesure. -- **value**: [float] La valeur numérique de la mesure effectuée. +- **value**:(Valeur): [float] La valeur numérique de la mesure effectuée. -- **unit**: [string] L'unité de mesure +- **unit**:(Unité): [string] L'unité de mesure -- **qualityFlag**: [boolean] Le reporteur de la mesure suspecte-t-il que la mesure est de mauvaise qualité? +- **qualityFlag**:(Indicateur de mauvaise qualité): [boolean] Le reporteur de la mesure suspecte-t-il que la mesure est de mauvaise qualité? -- **accessToPublic**: [boolean] Si "Non", la donnée ne sera pas accessible par le public. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToPublic**:(Accès au public): [boolean] Si "Non", la donnée ne sera pas accessible par le public. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToAllOrgs**: [boolean] Si "Non", la donnée ne sera pas accessible par toute organisation partenaire. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToAllOrgs**:(Accès à toutes les organisations): [boolean] Si "Non", la donnée ne sera pas accessible par toute organisation partenaire. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToSelf**: [boolean] Si "Non", la donnée ne sera pas accessible par le reporteur lui-même. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToSelf**:(Accès au reporteur lui-même): [boolean] Si "Non", la donnée ne sera pas accessible par le reporteur lui-même. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToPHAC**: [boolean] Si "Non", la donnée ne sera pas accessible par les employés de l'Agence de Santé Publique du Canada. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToPHAC**:(Accès à l'ASPC): [boolean] Si "Non", la donnée ne sera pas accessible par les employés de l'Agence de Santé Publique du Canada. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToLocalHA**: [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique locales. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToLocalHA**:(Accès à l'autorité de santé publique locale): [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique locales. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToProvHA**: [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée sera accessible à l'autorité de santé publique de la province où l'échantillonnage a été réalisée. +- **accessToProvHA**:(Accès à l'autorité de santé publique provinciale): [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée sera accessible à l'autorité de santé publique de la province où l'échantillonnage a été réalisée. -- **accessToOtherProv**: [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée leur sera accessible. +- **accessToOtherProv**:(Accès aux autres provinces): [boolean] Si "Non", la donnée ne sera pas accessible par les autorités de santé publique provinciales. Si "Oui" ou laissé vide, la donnée leur sera accessible. -- **accessToDetails**: [boolean] Indique si des informations supplémentaires sur la confidentialité de la mesure sont disponibles. +- **accessToDetails**:(Accès aux détails): [boolean] Indique si des informations supplémentaires sur la confidentialité de la mesure sont disponibles. -- **notes**: [string] Ajouter toutes notes additionnelles. +- **notes**:(Notes): [string] Ajouter toutes notes additionnelles. ## Reporter Le reporteur ou l'organisation responsable de la collecte de données ou responsable de la qualité des données reportées. -- **reporterID**: (Primary Key) [string] Identifiant unique pour la personne ou l'organisation responsable des données rapportées. +- **reporterID**:(Identifiant du reporteur): (Primary Key) [string] Identifiant unique pour la personne ou l'organisation responsable des données rapportées. -- **siteIDDefault**: (Foreign key) [string] Identifiant de Site utilisé par défaut quand un nouvel échantillon est créé par ce reporteur. Se référer à la colonne "siteID" dans la table "Site" +- **siteIDDefault**:(Identifiant du site par défaut): (Foreign key) [string] Identifiant de Site utilisé par défaut quand un nouvel échantillon est créé par ce reporteur. Se référer à la colonne "siteID" dans la table "Site" -- **labIDDefault**: (Foreign key) [string] Identifiant de Lab utilisé par défaut quand un nouvel échantillon est créé par ce reporteur. Se référer à la colonne "labID" dans la table "Lab" +- **labIDDefault**:(Identifiant laboratoire par défaut): (Foreign key) [string] Identifiant de Lab utilisé par défaut quand un nouvel échantillon est créé par ce reporteur. Se référer à la colonne "labID" dans la table "Lab" -- **contactName**: [string] Nom complet du reporter (personne ou organisation) +- **contactName**:(Nom du contact): [string] Nom complet du reporter (personne ou organisation) -- **contactEmail**: [string] Adresse courriel du contact. +- **contactEmail**:(Adresse électronique du contact): [string] Adresse courriel du contact. -- **contactPhone**: [string] Numéro de téléphone du contact. +- **contactPhone**:(Téléphone du contact): [string] Numéro de téléphone du contact. -- **notes**: [string] Ajouter toutes notes additionnelles. +- **notes**:(Notes): [string] Ajouter toutes notes additionnelles. ## Lab Laboratoire effectuant des analyses d'échantillons d'eaux usées d'un ou plusieurs sites. -- **labID**: (Primary Key) [string] Identifiant unique pour le laboratoire. +- **labID**:(Identifiant du laboratoire): (Primary Key) [string] Identifiant unique pour le laboratoire. -- **assayMethodIDDefault**: (Foreign key) [string] Identifiant de la méthode d'analyse utilisée par défaut quand une nouvelle mesure est créé par ce laboratoire. Se référer à la colonne "assayMethodID" dans la table "AssayMethod" +- **assayMethodIDDefault**:(Identifiant de la méthode d'analyse par défaut): (Foreign key) [string] Identifiant de la méthode d'analyse utilisée par défaut quand une nouvelle mesure est créé par ce laboratoire. Se référer à la colonne "assayMethodID" dans la table "AssayMethod" -- **name**: [string] Nom du laboratoire. +- **name**:(Nom): [string] Nom du laboratoire. -- **contactName**: [string] Personne contact de ce laboratoire. +- **contactName**:(Nom du contact): [string] Personne contact de ce laboratoire. -- **contactEmail**: [string] Adresse courriel du contact. +- **contactEmail**:(Adresse électronique du contact): [string] Adresse courriel du contact. -- **contactPhone**: [string] Numéro de téléphone du contact. +- **contactPhone**:(Téléphone du contact): [string] Numéro de téléphone du contact. -- **updateDate**: [date] Date où l'information a été reportée une première fois ou mise à jour. +- **updateDate**:(Date de mise à jour): [date] Date où l'information a été reportée une première fois ou mise à jour. ## AssayMethod La méthode d'analyse utilisée pour réaliser les mesures. Crée une nouvelle rangée dans cette table si des changements (améliorations) sont apportées à une technique d'analyse existante. Garder le même identifiant et modifier le numéro de version. Une nouvelle rangée représentant une nouvelle version d'une méthode existante peut inclure des informations seulement dans les colonnes qui ont changé d'une version à l'autre, cependant, nous recommandons de remplir les autres colonnes avec les valeurs provenant de la version précédente afin de décrire clairement la méthode en entier. Ajouter la date courante lorsqu'une nouvelle rangée est créée. -- **assayMethodID**: (Primary Key) [string] Identifiant unique pour la méthode d'analyse. +- **assayMethodID**:(Identifiant de la méthode d'analyse): (Primary Key) [string] Identifiant unique pour la méthode d'analyse. -- **instrumentID**: (Foreign key) [string] Crée un lien vers la table "Instrument" pour décrire l'appareil utilisé pour effectuer la mesure. +- **instrumentID**:(Identifiant de l'instrument): (Foreign key) [string] Crée un lien vers la table "Instrument" pour décrire l'appareil utilisé pour effectuer la mesure. -- **name**: [string] Nom de la méthode d'analyse. +- **name**:(Nom): [string] Nom de la méthode d'analyse. -- **version**: [string] Version de la méthode d'analyse. Un versionnement de type sémantique est recommandé. +- **version**:(Version): [string] Version de la méthode d'analyse. Un versionnement de type sémantique est recommandé. -- **summary**: [string] Brève description de la méthode d'analyse et de comment celle-ci diffère d'autres méthodes. +- **summary**:(Résumé): [string] Brève description de la méthode d'analyse et de comment celle-ci diffère d'autres méthodes. -- **referenceLink**: [string] Lien vers la procédure standard. +- **referenceLink**:(Lien vers référence): [string] Lien vers la procédure standard. -- **date**: [date] Date à laquelle la méthode d'analyse (ou une nouvelle version d'une méthode existante) a été crée. +- **date**:(Date): [date] Date à laquelle la méthode d'analyse (ou une nouvelle version d'une méthode existante) a été crée. -- **aliasID**: [string] Identifiants d'autres méthodes d'analyse présentes dans la table qui sont similaires à la méthode courante. Insérer sous forme de liste séparée par des virgules. +- **aliasID**:(Identifiant de l'alias): [string] Identifiants d'autres méthodes d'analyse présentes dans la table qui sont similaires à la méthode courante. Insérer sous forme de liste séparée par des virgules. -- **sampleSizeL**: [float] Volume de l'échantillon analysé (en litres) +- **sampleSizeL**:(Volume de l'échantillon l): [float] Volume de l'échantillon analysé (en litres) -- **loq**: [float] Limite de quantification pour cette méthode, le cas échéant. +- **loq**:(Limite de quantification): [float] Limite de quantification pour cette méthode, le cas échéant. -- **lod**: [float] Limite de détection pour cette méthode, le cas échéant. +- **lod**:(Limite de détection): [float] Limite de détection pour cette méthode, le cas échéant. -- **unit**: [category] Unité de mesure utilisée par cette méthode et qui est applicable pour la limite de détection ou de quantification. +- **unit**:(Unité): [category] Unité de mesure utilisée par cette méthode et qui est applicable pour la limite de détection ou de quantification. - `gcPMMoV`: Copies de gène ou de variant par copie de PMMoV - `gcMl`: Copies de gène ou de variant par millilitre. - `gcGms`: Copies de gène ou de variant par gramme de solides. @@ -518,99 +518,99 @@ La méthode d'analyse utilisée pour réaliser les mesures. Crée une nouvelle r - `gcCrA`: Copies de gène ou de variant par copie de CrAssphage - `other`: Autre mesure de copies virales ou de qualité des eaux usées. Ajouter une description dans "unitOther" -- **unitOther**: [string] Unité de mesure utilisée par cette méthode et qui est applicable pour la limite de détection ou de quantification dans le cas où celle-ci n'est pas disponible. +- **unitOther**:(Unité autre): [string] Unité de mesure utilisée par cette méthode et qui est applicable pour la limite de détection ou de quantification dans le cas où celle-ci n'est pas disponible. -- **methodConc**: [string] Description de la méthode utilisée pour concentrer l'échantillon. +- **methodConc**:(Méthode de concentration): [string] Description de la méthode utilisée pour concentrer l'échantillon. -- **methodExtract**: [string] Description de la méthode utilisée pour extraire l'échantillon. +- **methodExtract**:(Méthode d'extraction): [string] Description de la méthode utilisée pour extraire l'échantillon. -- **methodPcr**: [string] Description de la m.éthode PCR utiisée. +- **methodPcr**:(Méthode PCR): [string] Description de la m.éthode PCR utiisée. -- **qualityAssQC**: [string] Description des étapes de contrôle de qualité mises en place dans la méthode. +- **qualityAssQC**:(Contrôle de qualité): [string] Description des étapes de contrôle de qualité mises en place dans la méthode. -- **inhibition**: [string] Description des paramètres d'inhibition liés à cette méthode. +- **inhibition**:(Inhibition): [string] Description des paramètres d'inhibition liés à cette méthode. -- **surrogateRecovery**: [string] Description de la méthode de récupération du virus de substitution liée à cette méthode. +- **surrogateRecovery**:(Récupération du virus substitut): [string] Description de la méthode de récupération du virus de substitution liée à cette méthode. ## Instrument L'instrument utilisé pour mesurer les échantillons et l'eau usée des sites d'échantillonnage. La méthode d'analyse pour les mesures virales sont décrites dans la table "AssayMethod". -- **instrumentID**: (Primary Key) [string] Identifiant unique pour l'instrument de mesure. +- **instrumentID**:(Identifiant de l'instrument): (Primary Key) [string] Identifiant unique pour l'instrument de mesure. -- **name**: [string] Nom de l'instrument de mesure. +- **name**:(Nom): [string] Nom de l'instrument de mesure. -- **model**: [string] Numéro de modèle et/ou de version de l'instrument de mesure. +- **model**:(Modèle): [string] Numéro de modèle et/ou de version de l'instrument de mesure. -- **description**: [string] Description de l'instrument. +- **description**:(Description): [string] Description de l'instrument. -- **alias**: [string] Identifiants d'autres instruments présents dans la table qui sont similaires à l'instrument courant. Insérer sous forme de liste séparée par des virgules. +- **alias**:(Alias): [string] Identifiants d'autres instruments présents dans la table qui sont similaires à l'instrument courant. Insérer sous forme de liste séparée par des virgules. -- **referenceLink**: [string] Lien vers un document de référence pour l'instrument de mesure. +- **referenceLink**:(Lien vers référence): [string] Lien vers un document de référence pour l'instrument de mesure. -- **type**: [category] Type de l'instrument de mesure. +- **type**:(Type): [category] Type de l'instrument de mesure. - `online`: Capteur en ligne. - `lab`: Analyse en laboratoire. - `hand`: Mesure à l'aide d'un capteur manuel. - `atline`: Mesure à l'aide d'un échantillonneur. - `other`: Autre type d'appareil de mesure. Ajouter une description dans "instrumentTypeOther" -- **typeOther**: [string] Description du type d'instrument dans le cas où il ne serait pas disponible. +- **typeOther**:(Type autre): [string] Description du type d'instrument dans le cas où il ne serait pas disponible. ## Polygon Polygone englobant une région de la surface terrestre. Normalement, ces polygones représentent soit des bassin de drainage d'un réseau d'égouts ou une région de santé publique, ou une autre région associée à des données reportées. -- **polygonID**: (Primary Key) [string] Identifiant unique du polygone. +- **polygonID**:(Identifiant du polygone): (Primary Key) [string] Identifiant unique du polygone. -- **name**: [string] Nom du polygon (devrait être descriptif) +- **name**:(Nom): [string] Nom du polygon (devrait être descriptif) -- **pop**: [integer] Population approximative vivant dans la région représentée par le polygone. +- **pop**:(Population): [integer] Population approximative vivant dans la région représentée par le polygone. -- **type**: [category] Type de polygone. +- **type**:(Type): [category] Type de polygone. - `swrCat`: Zone de captage d'un réseau d'égout. - `hlthReg`: Région de santé desservie par le réseau d'égout. -- **wkt**: [string] Description formelle du polygone (format Well-Known-Text (wkt)) +- **wkt**:(Wkt): [string] Description formelle du polygone (format Well-Known-Text (wkt)) -- **file**: [blob] Fichier représentant la géométrie du polygone (blob). +- **file**:(Fichier): [blob] Fichier représentant la géométrie du polygone (blob). -- **link**: [string] Lien vers une référence externe décrivant la géométrie du polygone. +- **link**:(Lien): [string] Lien vers une référence externe décrivant la géométrie du polygone. ## CovidPublicHealthData Données de patients pour la COVID-19 pour une région spécifiée par un polygone. -- **cphdID**: (Primary Key) [string] Identifiant unique pour l'information de santé publique reportée. +- **cphdID**:(Identifiant de CPHD): (Primary Key) [string] Identifiant unique pour l'information de santé publique reportée. -- **reporterID**: (Foreign key) [string] Identifiant unique pour la personne ou l'organisation responsable des données rapportées. +- **reporterID**:(Identifiant du reporteur): (Foreign key) [string] Identifiant unique pour la personne ou l'organisation responsable des données rapportées. -- **polygonID**: (Foreign key) [string] Crée un lien vers la table "Polygon". Le polygon lié devrait englober la région représentée par les données consignées ici. +- **polygonID**:(Identifiant du polygone): (Foreign key) [string] Crée un lien vers la table "Polygon". Le polygon lié devrait englober la région représentée par les données consignées ici. -- **date**: [string] Date de reportage des données de mesure de la COVID-19. +- **date**:(Date): [string] Date de reportage des données de mesure de la COVID-19. -- **type**: [category] Type de donnée de mesure de la COVID-19. +- **type**:(Type): [category] Type de donnée de mesure de la COVID-19. - `conf`: Nombre de cas confirmés. La mesure devrait être accompagnée d'une valeur dans la colonne "dateType" - `active`: Nombre de cas actifs. - `test`: Nombre de tests effectués. @@ -619,31 +619,31 @@ Données de patients pour la COVID-19 pour une région spécifiée par un polygo - `hospCen`: Rencensement des patients admis à un hôpital avec la COVID-19. - `hospAdm`: Nombre d'admissions ou nombre de patients admis à l'hôpital. -- **dateType**: [category] Type de date utiisée pour reporter les données. +- **dateType**:(Type de date): [category] Type de date utiisée pour reporter les données. - `episode`: Date estimée à laquelle l'épisode de maladie s'est déclaré. Habituellement calculé en se basant sur la date des premiers symptômes, la date de test ou la date de reportage. - `onset`: Date à laquelle les premiers symptômes apparaissent. Cette donnée est souvent inconnue. La date d'épisode est alors communément utilisée. - `report`: Date à laquelle la donnée a été reportée à la santé publique. Cette mesure est communément utilisée. - `test`: Date à laquelle le test de COVID-19 a été effectué. -- **value**: [float] La valeur numérique de la mesure reportée. +- **value**:(Valeur): [float] La valeur numérique de la mesure reportée. -- **notes**: [string] Ajouter toutes notes additionnelles. +- **notes**:(Notes): [string] Ajouter toutes notes additionnelles. ## Lookup Utiliser pour retrouver les valeurs associées aux colonnes contenant des données catégoriques. -- **tableName**: [string] Nom de la table. +- **tableName**:(Nom de la table): [string] Nom de la table. -- **columnName**: [string] Nom de la colonne. +- **columnName**:(Nom de la colonne): [string] Nom de la colonne. -- **value**: [string] Nom de la valeur. +- **value**:(Valeur): [string] Nom de la valeur. -- **description**: [string] Nom de la description. +- **description**:(Description): [string] Nom de la description. diff --git a/src/generate_db_generations_sql.R b/src/generate_db_generations_sql.R index 0742d5cb..85f0190f 100644 --- a/src/generate_db_generations_sql.R +++ b/src/generate_db_generations_sql.R @@ -77,6 +77,7 @@ wbe_metadata_generation <- function(curr_wd = getwd(), lang = "fr"){ variableDesc_var_nm <- paste0("variableDesc", "_", lang) tableDesc_var_nm<- paste0("tableDesc", "_", lang) cats_desc_nm <- paste0("desc", "_", lang) + variableLabel_nm <- paste0("variableLabel", "_", lang) md_str <- tbls$tableName %>% @@ -108,6 +109,8 @@ wbe_metadata_generation <- function(curr_wd = getwd(), lang = "fr"){ type_str <- if(is.na(cur_col_details$variableType) | nchar(cur_col_details$variableType) == 0){""}else{glue(" [{cur_col_details$variableType}]")} + + vals_str <- if(cur_col_details$variableType == "category"){ @@ -128,7 +131,11 @@ wbe_metadata_generation <- function(curr_wd = getwd(), lang = "fr"){ } else{""} - glue("-\t**{curr_col}**:{key_str}{type_str} {cur_col_details[[variableDesc_var_nm]]}\n{vals_str}") + ############################################# + # + # This glue is important for the order and formating of the metadata file for variables + # + glue("-\t**{curr_col}**:({cur_col_details[[variableLabel_nm]]}):{key_str}{type_str} {cur_col_details[[variableDesc_var_nm]]}\n{vals_str}") }) md_cols_all <- md_cols %>% paste0(collapse = "\n\n") @@ -439,12 +446,11 @@ wbe_db_setup <- function(lang = "en"){ wbe_sql_write_db_creation(lang = lang) wbe_create_db_from_script(lang = lang) } -# -# wbe_db_setup("en") -# wbe_metadata_write("en") -# wbe_metadata_write("") -langs <- c("en", "fr") + +######################################## +#' Do things for diffferent languages +langs <- c("en", "fr") lapply(langs, wbe_db_setup) lapply(langs, wbe_metadata_write)