diff --git a/README.md b/README.md index 43b3355..ec0f71d 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,10 @@ # predval + + + PREDVAL + + A predictions-in validation harness for clinical prediction models. predval answers one question: **do a model's published probabilities hold up on your cohort?** diff --git a/docs/branding/FONT-LICENSE.txt b/docs/branding/FONT-LICENSE.txt new file mode 100644 index 0000000..b3d93a1 --- /dev/null +++ b/docs/branding/FONT-LICENSE.txt @@ -0,0 +1,78 @@ +Format: https://www.debian.org/doc/packaging-manuals/copyright-format/1.0/ +Upstream-Name: DejaVu fonts +Upstream-Author: Stepan Roh (original author), + see /usr/share/doc/fonts-dejavu-core/AUTHORS for full list +Source: https://dejavu-fonts.github.io/ + +Files: * +Copyright: Copyright (c) 2003 by Bitstream, Inc. All Rights Reserved. + Bitstream Vera is a trademark of Bitstream, Inc. + DejaVu changes are in public domain. +License: bitstream-vera + Permission is hereby granted, free of charge, to any person obtaining a copy + of the fonts accompanying this license ("Fonts") and associated + documentation files (the "Font Software"), to reproduce and distribute the + Font Software, including without limitation the rights to use, copy, merge, + publish, distribute, and/or sell copies of the Font Software, and to permit + persons to whom the Font Software is furnished to do so, subject to the + following conditions: + . + The above copyright and trademark notices and this permission notice shall + be included in all copies of one or more of the Font Software typefaces. + . + The Font Software may be modified, altered, or added to, and in particular + the designs of glyphs or characters in the Fonts may be modified and + additional glyphs or characters may be added to the Fonts, only if the fonts + are renamed to names not containing either the words "Bitstream" or the word + "Vera". + . + This License becomes null and void to the extent applicable to Fonts or Font + Software that has been modified and is distributed under the "Bitstream + Vera" names. + . + The Font Software may be sold as part of a larger software package but no + copy of one or more of the Font Software typefaces may be sold by itself. + . + THE FONT SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS + OR IMPLIED, INCLUDING BUT NOT LIMITED TO ANY WARRANTIES OF MERCHANTABILITY, + FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT OF COPYRIGHT, PATENT, + TRADEMARK, OR OTHER RIGHT. IN NO EVENT SHALL BITSTREAM OR THE GNOME + FOUNDATION BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, INCLUDING + ANY GENERAL, SPECIAL, INDIRECT, INCIDENTAL, OR CONSEQUENTIAL DAMAGES, + WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF + THE USE OR INABILITY TO USE THE FONT SOFTWARE OR FROM OTHER DEALINGS IN THE + FONT SOFTWARE. + . + Except as contained in this notice, the names of Gnome, the Gnome + Foundation, and Bitstream Inc., shall not be used in advertising or + otherwise to promote the sale, use or other dealings in this Font Software + without prior written authorization from the Gnome Foundation or Bitstream + Inc., respectively. For further information, contact: fonts at gnome dot + org. + +Files: debian/* +Copyright: (C) 2005-2006 Peter Cernak + (C) 2006-2011 Davide Viti + (C) 2011-2013 Christian Perrier + (C) 2013 Fabian Greffrath +License: GPL-2+ + This program is free software; you can redistribute it + and/or modify it under the terms of the GNU General Public + License as published by the Free Software Foundation; either + version 2 of the License, or (at your option) any later + version. + . + This program is distributed in the hope that it will be + useful, but WITHOUT ANY WARRANTY; without even the implied + warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR + PURPOSE. See the GNU General Public License for more + details. + . + You should have received a copy of the GNU General Public + License along with this package; if not, write to the Free + Software Foundation, Inc., 51 Franklin St, Fifth Floor, + Boston, MA 02110-1301 USA + . + On Debian systems, the full text of the GNU General Public + License version 2 can be found in the file + /usr/share/common-licenses/GPL-2'. diff --git a/docs/branding/README.md b/docs/branding/README.md new file mode 100644 index 0000000..9d8ca4a --- /dev/null +++ b/docs/branding/README.md @@ -0,0 +1,18 @@ +# PREDVAL identity + +The coverage-grid mark represents a declared roster: one open cell, one highlighted cell, and a pair of brackets. It is a project identity, not a clinical certification mark. + +## Assets + +- `predval-lockup-light.svg` and `predval-lockup-dark.svg`: horizontal logo for light and dark backgrounds. +- `predval-icon-light.svg` and `predval-icon-dark.svg`: standalone square icon. + +All assets are transparent SVGs. Wordmarks use outlined paths and require no installed font. The root README selects the dark asset using `prefers-color-scheme` and supplies a light fallback with descriptive alt text. + +## Usage + +Use the light assets on white and the dark assets on a dark background such as `#0C1626`. Keep the horizontal logo at least 240 px wide. The icon has been checked at 32, 128, and 512 px. Preserve its aspect ratio and leave at least one grid-cell width of clear space around unrelated content. + +Palette: navy `#112D49`, violet `#6952C7`; dark-background foreground `#EDF3FA`, violet `#AD9AF4`. + +The wordmark is derived from DejaVu Sans Bold, with custom tracking and conversion to paths. See [FONT-LICENSE.txt](FONT-LICENSE.txt) for the font copyright and license notice. No font binaries are included. diff --git a/docs/branding/predval-icon-dark.svg b/docs/branding/predval-icon-dark.svg new file mode 100644 index 0000000..479e5db --- /dev/null +++ b/docs/branding/predval-icon-dark.svg @@ -0,0 +1 @@ +PREDVAL coverage grid diff --git a/docs/branding/predval-icon-light.svg b/docs/branding/predval-icon-light.svg new file mode 100644 index 0000000..bd748b3 --- /dev/null +++ b/docs/branding/predval-icon-light.svg @@ -0,0 +1 @@ +PREDVAL coverage grid diff --git a/docs/branding/predval-lockup-dark.svg b/docs/branding/predval-lockup-dark.svg new file mode 100644 index 0000000..7115909 --- /dev/null +++ b/docs/branding/predval-lockup-dark.svg @@ -0,0 +1 @@ +PREDVAL diff --git a/docs/branding/predval-lockup-light.svg b/docs/branding/predval-lockup-light.svg new file mode 100644 index 0000000..f93fcdd --- /dev/null +++ b/docs/branding/predval-lockup-light.svg @@ -0,0 +1 @@ +PREDVAL