Terms of use metadata
Some new metadata columns have been added to help identify which sample sets have usage restrictions (e.g., publication embargo) and which are available for unrestricted use. The metadata columns are:
terms_of_use_expiry_date
- Gives the date on which any terms of use will expire. After this date, there will be no usage restrictions on data relating to the sample set.terms_of_use_url
- Gives the address of a web page that describes any usage restrictions which apply to the sample set.
If the value of either of these fields is empty then there are no terms of use applying to the sample set.
These new metadata columns can be accessed via the malariagen_data
Python API. The API also addes an additional computed field:
unrestricted_use
- This is a computed column which is added for convenience. The value isTrue
if the terms of use have expired, or if there were never any usage restrictions applied.
The metadata columns are available in the dataframes returned by the sample_sets()
and sample_metadata()
functions. Below are some examples for data from the Anopheles gambiae complex accessed via the Ag3
API. Similar code can be used for Anopheles funestus samples via the Af1
API.
import malariagen_data
ag3 = malariagen_data.Ag3()
Sample set metadata:
df_sample_sets = ag3.sample_sets()
df_sample_sets[["sample_set", "terms_of_use_expiry_date", "unrestricted_use"]]
Query to find sample sets with no usage restrictions:
df_sample_sets.query("unrestricted_use")
Sample metadata:
df_samples = ag3.sample_metadata()
df_samples[["sample_id", "sample_set", "terms_of_use_expiry_date", "terms_of_use_url", "unrestricted_use"]]
Query to find samples with no usage restrictions:
df_samples.query("unrestricted_use")
Example query to combine with other filters:
df_samples.query("country == 'Burkina Faso' and unrestricted_use")
Note that all sample sets in the vector observatory can be accessed and analysed at any time for public health purposes. If any terms of use apply, they may restrict the public communication of any analysis results (publication embargo) for a period of time.
If you have any questions about usage restrictions, please get in touch via support@malariagen.net.